调用DescribeLiveDomainDetail获取指定直播域名配置的基本信息。

使用说明

本接口支持查询指定推流域名或播流域名的基本配置信息。

如果是新增域名的查询，域名配置完成需要一定时间，分钟级别，完全配置成功后可支持查询。

QPS限制

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

调试

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

请求参数

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

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

DomainName String 是 demo.aliyundoc.com

直播推流域名或播流域名。

返回数据

名称 类型 示例值 描述
DomainDetail Struct

域名配置详情。
CertName String liveCert****

证书名称。
Cname String learn.developer.aliyundoc.com

CNAME域名。为直播域名生成一个CNAME域名，需要在域名解析服务商处将直播域名CNAME解析到该域名。

说明 由于Local DNS的解析记录存在缓存时间，因此在配置域名的CNAME解析记录之后大约会延迟10分钟才会显示CNAME解析记录配置成功。详细内容，请参见CNAME解析常见问题。
Description String test

域名备注，说明信息。
DomainName String demo.aliyundoc.com

直播推流域名或播流域名。
DomainStatus String online

直播域名运行状态。取值：

  • online：启用。
  • offline：停用。
  • configuring：配置中。
GmtCreated String 2018-07-27T06:51:25Z

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

GmtModified String 2018-08-07T06:51Z

最近修改时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

LiveDomainType String liveVideo

域名业务类型。取值：

  • liveVideo：播流域名。
  • liveEdge：边缘推流域名。
Region String cn-shanghai

域名所属地域。
SSLProtocol String on

是否开启SSL证书。取值：

  • on：开启。
  • off：关闭。
SSLPub String Public Key

证书公钥。
Scope String domestic

加速区域。取值：

  • domestic：中国内地。
  • overseas：海外及港澳台加速。
  • global：全球加速。
RequestId String 09ABE829-6CD3-4FE0-AFEE-556113E29727

请求ID。

示例

请求示例

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

正常返回示例

XML格式 

<DescribeLiveDomainDetailResponse>
  <DomainDetail>
        <Description>test</Description>
        <Scope>domestic</Scope>
        <LiveDomainType>liveVideo</LiveDomainType>
        <DomainName>demo.aliyundoc.com</DomainName>
        <SSLPub>Public Key</SSLPub>
        <GmtModified>2018-08-07T06:51Z</GmtModified>
        <Region>cn-shanghai</Region>
        <CertName>liveCert****</CertName>
        <GmtCreated>2018-07-27T06:51:25Z</GmtCreated>
        <Cname>learn.developer.aliyundoc.com</Cname>
        <DomainStatus>online</DomainStatus>
        <SSLProtocol>on</SSLProtocol>
  </DomainDetail>
  <RequestId>09ABE829-6CD3-4FE0-AFEE-556113E29727</RequestId>
</DescribeLiveDomainDetailResponse>

JSON格式 

{
    "DescribeLiveDomainDetailResponse": {
        "DomainDetail": {
            "Description": "test",
            "Scope": "domestic",
            "LiveDomainType": "liveVideo",
            "DomainName": "demo.aliyundoc.com",
            "SSLPub": "Public Key",
            "GmtModified": "2018-08-07T06:51Z",
            "Region": "cn-shanghai",
            "CertName": "liveCert****",
            "GmtCreated": "2018-07-27T06:51:25Z",
            "Cname": "learn.developer.aliyundoc.com",
            "DomainStatus": "online",
            "SSLProtocol": "on"
        },
        "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727"
    }
}

错误码

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