DescribeLivePrivateLineAvailGA - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the binding information between an Alibaba Cloud Global Accelerator (GA) instance and a live channel.

Operation description

Set the IsGaInstance parameter to yes to query the status of the GA instance. Set the parameter to no to query the binding details between the GA instance and the live channel.

QPS limit

Each user can make up to 50 queries per second (QPS). If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this API at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLivePrivateLineAvailGA

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	demo.aliyundoc.com
AppName	string	No	The application name.	live
StreamName	string	No	The stream name.	testStream
AccelerationArea	string	No	The acceleration channel.	ap-southeast-1
VideoCenter	string	No	The live center. Valid values: cn-beijing (Beijing), cn-shanghai (Shanghai), cn-shenzhen (Shenzhen), cn-qingdao (Qingdao), ap-northeast-1 (Tokyo), ap-southeast-5 (Jakarta), eu-central-1 (Frankfurt), ap-southeast-1 (Singapore), and ap-south-1 (Mumbai).	cn-shanghai
IsGaInstance	string	Yes	Specifies whether to query a GA instance. Valid values: yes: queries the status of the GA instance. no: queries the binding details between the GA instance and the live channel.	no

Response elements

Element	Type	Description	Example
	object	The response.
LivePrivateLineAvailGAs	object
LivePrivateLineAvailGA	array<object>	The configuration details of the GA instance.
	object	The configuration details of the GA instance.
AccelerationArea	string	The acceleration channel.	ap-southeast-1
AccelerationType	string	The acceleration type. Valid values: play: stream playback acceleration. publish: stream ingest acceleration.	play
AppName	string	The application name.	live
BindingStatus	string	Indicates whether the instance is attached to a live channel. Valid values: yes: The instance is attached. no: The instance is not attached.	yes
DomainName	string	The 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 instance. Valid values: active: The instance is active. inactive: The instance is inactive.	active
StreamName	string	The stream name.	testStream
Uid	string	The UID.	1833220971116****
VideoCenter	string	The live center.	cn-shanghai
RequestId	string	The request ID.	C4865B85-664B-19D3-BB16-C62FB83C8226

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.