DescribeLivePrivateLineAvailGA - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the binding information between Global Accelerator (GA) instances and acceleration circuits.

Operation description

If you set the IsGaInstance parameter to yes, the status of GA instances is queried. If you set the IsGaInstance parameter to no, the binding information between GA instances and acceleration circuits is 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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLivePrivateLineAvailGA		Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The main streaming domain.	demo.aliyundoc.com
AppName	string	No	The name of the application.	live
StreamName	string	No	The name of the live stream.	testStream
AccelerationArea	string	No	The acceleration channel.	ap-southeast-1
VideoCenter	string	No	The live center. Valid values: cn-beijing, cn-shanghai, cn-shenzhen, cn-qingdao, ap-northeast-1, ap-southeast-5, eu-central-1, ap-southeast-1, and ap-south-1. cn-beijing indicates China (Beijing). cn-shanghai indicates China (Shanghai). cn-shenzhen indicates China (Shenzhen). cn-qingdao indicates China (Qingdao). ap-northeast-1 indicates Japan (Tokyo). ap-southeast-5 indicates Indonesia (Jakarta). eu-central-1 indicates Germany (Frankfurt). ap-southeast-1 indicates Singapore.	cn-shanghai
IsGaInstance	string	Yes	Specifies whether to query Global Accelerator (GA) instances. Valid values: yes: queries the status of GA instances. no: queries the binding information between GA instances and acceleration circuits.	no

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "LivePrivateLineAvailGAs": {
    "LivePrivateLineAvailGA": [
      {
        "AccelerationArea": "ap-southeast-1",
        "AccelerationType": "play",
        "AppName": "live",
        "BindingStatus": "yes",
        "DomainName": "demo.aliyundoc.com",
        "IP": "127.0.0.1",
        "InstanceId": "ga-bp1iovsdpf01ym9su****",
        "Status": "active",
        "StreamName": "testStream",
        "Uid": "1833220971116****",
        "VideoCenter": "cn-shanghai"
      }
    ]
  },
  "RequestId": "C4865B85-664B-19D3-BB16-C62FB83C8226"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	Parameter invalid.	Illegal input parameters
500	InternalError	The request processing has failed due to backend service exception.	-

For a list of error codes, visit the Service error codes.