DescribeLivePrivateLineAvailGA - 查询全球加速配置

查询全球加速实例和直播链路的绑定信息。

接口说明

请求参数 IsGaInstance 为 yes 时,表示查询全球加速实例状态,为 no 时,表示查询全球加速实例和直播链路的绑定详情。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLivePrivateLineAvailGA
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
DomainNamestring

主播流域名。

demo.aliyundoc.com
AppNamestring

应用名称。

live
StreamNamestring

直播流名称。

testStream
AccelerationAreastring

加速通道。

ap-southeast-1
VideoCenterstring

直播中心,取值:cn-beijing、cn-shanghai、cn-shenzhen、cn-qingdao、ap-northeast-1、ap-southeast-5、eu-central-1、ap-southeast-1、ap-south-1,分别表示位于北京、上海、深圳、青岛、日本、印尼、德国、新加坡的直播中心。

cn-shanghai
IsGaInstancestring

查询全球加速实例,取值:

  • yes:查询全球加速实例状态。
  • no:查询全球加速实例和直播链路的绑定详情。
no

返回参数

名称类型描述示例值
object

返回结果。

LivePrivateLineAvailGAsarray<object>

全球加速实例配置详情。

LivePrivateLineAvailGAobject

全球加速实例配置详情。

AccelerationAreastring

加速通道。

ap-southeast-1
AccelerationTypestring

加速类型,取值:

  • play:播流加速。
  • publish:推流加速。
play
AppNamestring

应用名称。

live
BindingStatusstring

是否绑定到直播链路,取值:

  • yes:已绑定。
  • no:未绑定。
yes
DomainNamestring

主播流域名。

demo.aliyundoc.com
IPstring

加速 IP 地址。

127.0.0.1
InstanceIdstring

全球加速实例 ID。

ga-bp1iovsdpf01ym9su****
Statusstring

实例状态,取值:

  • active:可用。
  • inactive:不可用。
active
StreamNamestring

直播流名称。

testStream
Uidstring

UID。

1833220971116****
VideoCenterstring

直播中心。

cn-shanghai
RequestIdstring

请求 ID。

C4865B85-664B-19D3-BB16-C62FB83C8226

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParamParameter invalid.输入参数不合法
500InternalErrorThe request processing has failed due to backend service exception.-

访问错误中心查看更多错误码。

特殊错误码

错误代码描述HTTP 状态码语义
InvalidDomain.NotFoundThe domain provided does not exist in our records.404当前账户下未查到域名。
InvalidParamParameter invalid.400参数错误。
InternalErrorThe request processing has failed due to some unknown error.500后台发生未知错误。