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

使用说明

目前服务地址仅支持:华东2(上海)

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:DescribeVodDomainDetail

DomainName String example.com

点播加速域名名称。

返回数据

名称 类型 示例值 描述
RequestId String 09ABE829-6CD3-4FE0-556113E2****

请求ID。

DomainDetail Object

域名配置的基本信息。

GmtCreated String 2017-11-27T06:51:26Z

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Weight String 1

权重。

SSLPub String yourSSLPub

如果开启https,此处为证书公钥。

Description String testDescription

点播加速域名描述。

SSLProtocol String on

是否开启ssl证书。取值:

  • on:开启。
  • off:关闭。
CertName String testCertName

如果开启https,此处为证书名称。

Scope String domestic

国际用户、国内L3及以上用户设置有效。 取值:

  • domestic(默认):中国大陆。
  • overseas:港澳台及海外。
  • global:全球加速。
Cname String example.com.w.alikunlun.net

为加速域名生成的一个CNAME域名,需要在域名解析服务商处将加速域名CNAME解析到该域名。

DomainStatus String online

加速域名运行状态。取值意义:

  • online:表示启用。
  • offline:表示停用。
  • configuring:表示配置中。
  • configure_failed:表示配置失败。
  • checking:表示正在审核。
  • check_failed:表示审核失败。
GmtModified String 2017-11-27T06:55:26Z

最近修改时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

DomainName String example.com

点播加速域名。

Sources Array of Source

源站信息。

Source
Type String oss

源站类型。取值:

  • ipaddr:IP源站。
  • domain:域名源站。
  • oss:OSS Bucket为源站。
Priority String 50

优先级。

Port Integer 80

端口。支持443和80。

Content String ****.oss-cn-hangzhou.aliyuncs.com

回源地址。

Enabled String online

源站状态。取值:

  • online:启用。
  • offline:停用。

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=DescribeVodDomainDetail
&DomainName=example.com
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVodDomainDetailResponse>
    <RequestId>09ABE829-6CD3-4FE0-556113E2****</RequestId>
    <DomainDetail>
        <GmtCreated>2017-11-27T06:51:26Z</GmtCreated>
        <Weight>1</Weight>
        <SSLPub>yourSSLPub</SSLPub>
        <Description>testDescription</Description>
        <SSLProtocol>on</SSLProtocol>
        <CertName>testCertName</CertName>
        <Scope>domestic</Scope>
        <Cname>example.com.w.alikunlun.net</Cname>
        <DomainStatus>online</DomainStatus>
        <GmtModified>2017-11-27T06:55:26Z</GmtModified>
        <DomainName>example.com</DomainName>
        <Sources>
            <Type>oss</Type>
            <Priority>50</Priority>
            <Port>80</Port>
            <Content>****.oss-cn-hangzhou.aliyuncs.com</Content>
            <Enabled>online</Enabled>
        </Sources>
    </DomainDetail>
</DescribeVodDomainDetailResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "09ABE829-6CD3-4FE0-556113E2****",
  "DomainDetail" : {
    "GmtCreated" : "2017-11-27T06:51:26Z",
    "Weight" : "1",
    "SSLPub" : "yourSSLPub",
    "Description" : "testDescription",
    "SSLProtocol" : "on",
    "CertName" : "testCertName",
    "Scope" : "domestic",
    "Cname" : "example.com.w.alikunlun.net",
    "DomainStatus" : "online",
    "GmtModified" : "2017-11-27T06:55:26Z",
    "DomainName" : "example.com",
    "Sources" : [ {
      "Type" : "oss",
      "Priority" : "50",
      "Port" : 80,
      "Content" : "****.oss-cn-hangzhou.aliyuncs.com",
      "Enabled" : "online"
    } ]
  }
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。视频点播通用的错误码信息,请参见错误码表

错误代码

错误信息

HTTP 状态码

说明

InvalidDomain.NotFound

The domain provided does not belong to you.

404

域名不存在或不属于当前用户。

ServiceBusy

The specified Domain is configuring, please retry again later.

403

域名正在配置中,请稍后再试。