DocsICP FilingConsole
Documentation

DescribeLivePrivateLineAvailGA

Updated at:
Copy as MD
Product
My Favorites

Queries the attachment information between an Alibaba Cloud Global Accelerator (GA) instance and a live streaming link.

Operation description

When the request parameter IsGaInstance is set to yes, the Alibaba Cloud Global Accelerator (GA) instance status is queried. When it is set to no, the attachment details between the GA instance and the live streaming link are queried.

QPS limit

The single-user QPS limit for this API is 50 calls per second. If this limit is exceeded, the API call is throttled, which may affect your business. Invoke this operation appropriately.

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

get

*Domain

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

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

No

The region ID.

cn-shanghai
DomainName

string

Yes

The streamer's streaming domain.

demo.aliyundoc.com
AppName

string

No

The application name.

live
StreamName

string

No

The live stream name.

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, and ap-southeast-1, ap-south-1, which represent the live centers located in Beijing, Shanghai, Shenzhen, Qingdao, Japan, Indonesia, Germany, and Singapore.

cn-shanghai
IsGaInstance

string

Yes

Specifies whether to query the Alibaba Cloud Global Accelerator (GA) instance. Valid values:

  • yes: Queries the GA instance status.

  • no: Queries the attachment details between the GA instance and the live streaming link.

Valid values:

  • no :

    Queries the attachment details between the Alibaba Cloud Global Accelerator (GA) instance and the live streaming link.

  • yes :

    Queries the Alibaba Cloud Global Accelerator (GA) instance status.

no

Response elements

Element

Type

Description

Example

object

The response parameters.

LivePrivateLineAvailGAs

object

LivePrivateLineAvailGA

array<object>

The configuration details of the Alibaba Cloud Global Accelerator (GA) instance.

object

The configuration details of the Alibaba Cloud Global Accelerator (GA) instance.

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 application name.

live
BindingStatus

string

Indicates whether the instance is bound to a live streaming link. Valid values:

  • yes: Bound.

  • no: Not bound.

yes
DomainName

string

The streamer's streaming domain.

demo.aliyundoc.com
IP

string

The acceleration IP address.

127.0.0.1
InstanceId

string

The Alibaba Cloud Global Accelerator (GA) instance ID.

ga-bp1iovsdpf01ym9su****
Status

string

The instance status. Valid values:

  • active: Active.

  • inactive: Inactive.

active
StreamName

string

The live stream name.

testStream
Uid

string

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.