DescribeLivePrivateLineAvailGa - ApsaraVideo Live

Usage notes

If you set the IsGaInstance parameter to yes, the status of GA instances are queried. If you set the IsGaInstance parameter to no, the binding information between GA instances and acceleration circuits are queried.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLivePrivateLineAvailGA	The operation that you want to perform. Set the value to DescribeLivePrivateLineAvailGA.
DomainName	String	Yes	demo.aliyundoc.com	The main streaming domain.
AppName	String	No	live	The name of the application.
StreamName	String	No	testStream	The name of the live stream.
AccelerationArea	String	No	ap-southeast-1	The acceleration channel.
VideoCenter	String	No	cn-shanghai	The live center. Valid values: cn-beijing, cn-shanghai, cn-shenzhen, cn-qingdao, ap-northeast-1, ap-southeast-5, eu-central-1, and ap-southeast-1, which indicate China (Beijing), China (Shanghai), China (Shenzhen), China (Qingdao), Japan (Tokyo), Indonesia (Jakarta), Germany (Frankfurt), and Singapore, respectively.
IsGaInstance	String	Yes	no	The specific information that you want to query. Valid values: yes: the status of GA instances. no: the binding information between GA instances and acceleration circuits.

Response parameters

Parameter	Type	Example	Description
LivePrivateLineAvailGAs	Array of LivePrivateLineAvailGA		The GA instance configuration details.
LivePrivateLineAvailGA
AccelerationArea	String	ap-southeast-1	The acceleration channel.
AccelerationType	String	play	The acceleration type. Valid values: play: streaming acceleration publish: stream ingest acceleration
AppName	String	live	The name of the application.
BindingStatus	String	yes	Indicates whether the GA instance is bound to an acceleration circuit. Valid values: yes no
DomainName	String	demo.aliyundoc.com	The main streaming domain.
IP	String	127.0.0.1	The accelerated IP address.
InstanceId	String	ga-bp1iovsdpf01ym9su****	The ID of the GA instance.
Status	String	active	The status of the GA instance. Valid values: active: The GA instance is available. inactive: The GA instance is unavailable.
StreamName	String	testStream	The name of the live stream.
Uid	String	1833220971116****	The UID.
VideoCenter	String	cn-shanghai	The live center.
RequestId	String	C4865B85-664B-19D3-BB16-C62FB83C8226	The request ID.

Examples

Sample requests

https://live.aliyuncs.com?Action=DescribeLivePrivateLineAvailGA&DomainName=demo.aliyundoc.com&IsGaInstance=no&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLivePrivateLineAvailGAResponse>
    <RequestId>C4865B85-664B-19D3-BB16-C62FB83C8226</RequestId>
    <LivePrivateLineAvailGAs>
        <LivePrivateLineAvailGA>
            <DomainName>xxx.example1.com</DomainName>
            <AppName>test</AppName>
            <StreamName>test</StreamName>
            <InstanceId>ga-bp1iovsdpf01ym9sulesm</InstanceId>
            <Uid>18332209711160785</Uid>
            <IP>127.0.0.1</IP>
            <VideoCenter>cn-shanghai</VideoCenter>
            <AccelerationArea>ap-southeast-1</AccelerationArea>
            <Status>active</Status>
            <AccelerationType>play</AccelerationType>
            <BindingStatus>yes</BindingStatus>
        </LivePrivateLineAvailGA>
    </LivePrivateLineAvailGAs>
</DescribeLivePrivateLineAvailGAResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C4865B85-664B-19D3-BB16-C62FB83C8226",
  "LivePrivateLineAvailGAs" : {
    "LivePrivateLineAvailGA" : [ {
      "DomainName" : "xxx.example1.com",
      "AppName" : "test",
      "StreamName" : "test",
      "InstanceId" : "ga-bp1iovsdpf01ym9sulesm",
      "Uid" : "18332209711160785",
      "IP" : "127.0.0.1",
      "VideoCenter" : "cn-shanghai",
      "AccelerationArea" : "ap-southeast-1",
      "Status" : "active",
      "AccelerationType" : "play",
      "BindingStatus" : "yes"
    } ]
  }
}

Error codes

For a list of error codes, see Service error codes.

Special error codes

Error code	Error message	HTTP status code	Description
InvalidDomain.NotFound	The domain provided does not exist in our records.	404	The domain name is not found within your Alibaba Cloud account.
InvalidParam	Parameter invalid.	400	One or more parameters are invalid.
InternalError	The request processing has failed due to some unknown error.	500	An unknown error occurred.