最近更新时间:2023.09.25 21:09:55
首次发布时间:2021.11.10 14:57:53
查询域名的详细信息,包括但不限于域名空间、CName、类型、域名状态。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询域名信息接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDomain | 接口名称。当前 API 的名称为 DescribeDomain 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 是 | ["push.example.com","pull.example.com"] | 域名列表 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of DomainList | - | 域名详细信息列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Vhost | String | push.example.com | 域名空间名称。 |
Domain | String | push.example.com | 推/拉流域名。 |
Status | Integer |
| 域名状态。状态说明如下所示。
|
Type | String |
| 域名类型,包含两种类型。
|
Region | String |
| 区域,包含 4 种类型。
|
CName | String | push.example.com.bytefcdn.com | Cname 信息。 |
CnameCheck | Integer |
| Cname 状态。
|
DomainCheck | Integer |
| 域名是否可用的状态。
|
ICPCheck | Integer | 0 | IPC 备案校验是否通过,是否过期信息。 |
CreateTime | String | 2006-01-02T15:04:05+08:00 | 创建时间。 |
CertDomain | String | *.example.com | 所绑定证书支持的泛域名。 |
ChainID | String | 21614 | 绑定的证书信息。 |
PushDomain | String | push.example.com | 绑定的推流域名。 |
POST https://live.volcengineapi.com?Action=DescribeDomain&Version=2020-08-01 { "DomainList": [ "push.example.com" ] }
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"DescribeDomain", "Version":"2020-08-01", "Service":"live", "Region":"cn-north-1" }, "Result":{ "DomainList":[ { "Domain":"push-rtmp-f5.example.com", "Status":0, "Type":"push", "Region":"cn", "CName":"push.example.com.bytefcdn.com", "PushDomain": "push.example.com", "Vhost": "push.example.com", "CnameCheck":0, "DomainCheck":0, "CreateTime":"2006-01-02T15:04:05+08:00" } ] } }
访问公共错误码获取详细信息。