文档

DescribeVodDomainDetail - 查询域名基本信息

更新时间:

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

接口说明

使用说明

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

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

点播加速域名名称。

example.com

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

09ABE829-6CD3-4FE0-556113E2****
DomainDetailobject

域名配置的基本信息。

GmtCreatedstring

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

2017-11-27T06:51:26Z
Weightstring

回源权重。

1
SSLPubstring

如果开启 HTTPS 安全加速,此处为 HTTPS 证书的公钥;如果未开启 HTTPS 安全加速,则不返回此参数。

yourSSLPub
Descriptionstring

点播加速域名描述。

testDescription
SSLProtocolstring

是否开启 SSL 证书。取值:

  • on:开启。
  • off:关闭。
on
CertNamestring

如果开启 HTTPS 安全加速,此处为 HTTPS 证书的名称;如果未开启 HTTPS 安全加速,则不返回此参数。

testCertName
Scopestring

加速区域。取值:

  • domestic(默认):仅中国内地。
  • overseas:全球(不包含中国内地)。
  • global:全球。
domestic
Cnamestring

为加速域名生成的一个 CNAME 域名,需要在域名解析服务商处将此加速域名 CNAME 解析到该域名。详细操作请参见配置 CNAME

example.com.w.alikunlun.net
DomainStatusstring

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

  • online:表示启用。
  • offline:表示停用。
  • configuring:表示配置中。
  • configure_failed:表示配置失败。
  • checking:表示正在审核。
  • check_failed:表示审核失败。
online
GmtModifiedstring

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

2017-11-27T06:55:26Z
DomainNamestring

点播加速域名。

example.com
Sourcesobject []

源站信息。

Typestring

源站类型。取值:

  • ipaddr:IP 源站。
  • domain:域名源站。
  • oss:OSS Bucket 为源站。
oss
Prioritystring

优先级。

50
Portinteger

端口。支持 443 和 80。

80
Contentstring

回源地址。

****.oss-cn-hangzhou.aliyuncs.com
Enabledstring

源站状态。取值:

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

示例

正常返回示例

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": {
      "Source": [
        {
          "Type": "oss",
          "Priority": "50",
          "Port": 80,
          "Content": "****.oss-cn-hangzhou.aliyuncs.com",
          "Enabled": "online",
          "Weight": ""
        }
      ]
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更

接口错误码

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

错误代码错误信息HTTP 状态码说明
InvalidDomain.NotFoundThe domain provided does not belong to you.404域名不存在或不属于当前用户。
ServiceBusyThe specified Domain is configuring, please retry again later.403域名正在配置中,请稍后再试。
  • 本页导读 (1)