调用DescribeLivePrivateLineAvailGa查询全球加速实例和直播链路的绑定信息。
使用说明
请求参数IsGaInstance为yes时,表示查询全球加速实例状态,为no时,表示查询全球加速实例和直播链路的绑定详情。
QPS限制
本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeLivePrivateLineAvailGA | 系统规定参数。取值:DescribeLivePrivateLineAvailGA。 |
DomainName | String | 是 | demo.aliyundoc.com | 主播流域名。 |
AppName | String | 否 | live | 应用名称。 |
StreamName | String | 否 | testStream | 直播流名称。 |
AccelerationArea | String | 否 | ap-southeast-1 | 加速通道。 |
VideoCenter | String | 否 | cn-shanghai | 直播中心,取值:cn-beijing、cn-shanghai、cn-shenzhen、cn-qingdao、ap-northeast-1、ap-southeast-5、eu-central-1、ap-southeast-1、ap-south-1,分别表示位于北京、上海、深圳、青岛、日本、印尼、德国、新加坡的直播中心。 |
IsGaInstance | String | 是 | no | 查询全球加速实例,取值:
|
返回数据
名称 |
类型 |
示例值 |
描述 |
LivePrivateLineAvailGAs | Array of LivePrivateLineAvailGA | 全球加速实例配置详情。 |
|
LivePrivateLineAvailGA | |||
AccelerationArea | String | ap-southeast-1 | 加速通道。 |
AccelerationType | String | play | 加速类型,取值:
|
AppName | String | live | 应用名称。 |
BindingStatus | String | yes | 是否绑定到直播链路,取值:
|
DomainName | String | demo.aliyundoc.com | 主播流域名。 |
IP | String | 127.0.0.1 | 加速IP地址。 |
InstanceId | String | ga-bp1iovsdpf01ym9su**** | 全球加速实例ID。 |
Status | String | active | 实例状态,取值:
|
StreamName | String | testStream | 直播流名称。 |
Uid | String | 1833220971116**** | UID。 |
VideoCenter | String | cn-shanghai | 直播中心。 |
RequestId | String | C4865B85-664B-19D3-BB16-C62FB83C8226 | 请求ID。 |
示例
请求示例
https://live.aliyuncs.com?Action=DescribeLivePrivateLineAvailGA&DomainName=demo.aliyundoc.com&IsGaInstance=no&<公共请求参数>
正常返回示例
XML
格式
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
格式
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"
} ]
}
}
错误码
访问错误中心查看更多错误码。
特殊错误码
错误代码 |
描述 |
HTTP状态码 |
语义 |
InvalidDomain.NotFound |
The domain provided does not exist in our records. |
404 |
当前账户下未查到域名。 |
InvalidParam |
Parameter invalid. |
400 |
参数错误。 |
InternalError |
The request processing has failed due to some unknown error. |
500 |
后台发生未知错误。 |