调用DescribeLiveUserDomains查询用户名下所有的直播域名。

使用说明

调用本接口查询用户名下所有的直播域名。本接口目前支持的直播域名业务类型为播流域名和边缘推流域名。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeLiveUserDomains

系统规定参数。取值：DescribeLiveUserDomains。

LiveDomainType String 否 liveVideo

直播域名业务类型。取值：

  • liveVideo：播流域名。
  • liveEdge：边缘推流域名。
说明 如果不设置此参数，则请求参数DomainName默认查询用户所有直播推流和播流域名。
PageSize Integer 否 20

分页大小。默认值为20，最大值为50。

PageNumber Integer 否 1

当前页码。取值范围：1~100000。

DomainName String 否 *.aliyundoc.com

域名模糊匹配过滤。

说明
  • 如果LiveDomainType（直播域名业务类型）取值为liveVideo，此参数不传值时，默认查询用户播流域名的相关信息。
  • 如果LiveDomainType（直播域名业务类型）取值为liveEdge，此参数不传值时，默认查询用户推流域名的相关信息。
RegionName String 否 cn-beijing

域名所属地域。
DomainSearchType String 否 fuzzy_match

域名查询类型。取值：

  • fuzzy_match（默认值）：模糊匹配。
  • pre_match：前匹配。
  • suf_match：后匹配。
  • full_match：完全匹配。
DomainStatus String 否 online

域名状态。取值：

  • online：运行中（表示域名服务状态正常）。
  • offline：已停止。
  • configuring：配置中。
Tag.N.Key String 否 TestKey

标签健。
Tag.N.Value String 否 TestValue

标签值。

返回数据

名称 类型 示例值 描述
Domains Array of PageData

返回直播域名的状态信息。
PageData
Cname String learn.developer.aliyundoc.com

直播域名对应的CNAME域名。
Description String test

备注说明。
DomainName String demo.aliyundoc.com

直播推流域名或播流域名。
GmtCreated String 2017-08-29T12:15:36Z

直播域名创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

GmtModified String 2017-12-29T12:15:36Z

直播域名修改时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

LiveDomainStatus String online

域名状态。取值：

  • online：运行中（表示域名服务状态正常）。
  • offline：已停止。
  • configuring：配置中。
LiveDomainType String liveVideo

直播域名业务类型。取值：

  • liveVideo：播流域名。
  • liveEdge：边缘推流域名。
RegionName String cn-beijing

域名所属地域。
PageNumber Long 1

返回数据的当前页码。
PageSize Long 100

分页大小。
RequestId String E4EBD2BF-5EB0-4476-8829-9D94E1B15267

请求ID。
TotalCount Long 1

总条数。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveUserDomains
&<公共请求参数>

正常返回示例

XML格式 

<DescribeLiveUserDomainsResponse>
  <Domains>
        <PageData>
              <LiveDomainStatus>online</LiveDomainStatus>
              <Description>test</Description>
              <RegionName>cn-beijing</RegionName>
              <LiveDomainType>liveVideo</LiveDomainType>
              <DomainName>demo.aliyundoc.com</DomainName>
              <GmtModified>2017-12-29T12:15:36Z</GmtModified>
              <GmtCreated>2017-08-29T12:15:36Z</GmtCreated>
              <Cname>learn.developer.aliyundoc.com</Cname>
        </PageData>
  </Domains>
  <TotalCount>1</TotalCount>
  <PageSize>100</PageSize>
  <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B15267</RequestId>
  <PageNumber>1</PageNumber>
</DescribeLiveUserDomainsResponse>

JSON格式 

{
    "DescribeLiveUserDomainsResponse": {
        "Domains": {
            "PageData": {
                "LiveDomainStatus": "online",
                "Description": "test",
                "RegionName": "cn-beijing",
                "LiveDomainType": "liveVideo",
                "DomainName": "demo.aliyundoc.com",
                "GmtModified": "2017-12-29T12:15:36Z",
                "GmtCreated": "2017-08-29T12:15:36Z",
                "Cname": "learn.developer.aliyundoc.com"
            }
        },
        "TotalCount": 1,
        "PageSize": 100,
        "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B15267",
        "PageNumber": 1
    }
}

错误码

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