You need to enable JavaScript to run this app.
导航
查询域名信息
最近更新时间:2023.10.12 17:39:56首次发布时间:2021.11.10 14:57:53

查询域名的详细信息,包括但不限于域名空间、CName、类型、域名状态。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询域名信息接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=DescribeDomain&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringDescribeDomain接口名称。当前 API 的名称为 DescribeDomain
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述
DomainListArray of String["push.example.com","pull.example.com"]域名列表

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
DomainListArray of DomainList-域名详细信息列表

DomainList

参数类型示例值描述
VhostStringpush.example.com域名空间名称。
DomainStringpush.example.com推/拉流域名。

Status

Integer

0

域名状态。状态说明如下所示。

  • 0:正常;
  • 1:审核中;
  • 2:禁用,禁止使用,此时 domain 不生效;
  • 3:删除;
  • 4:审核被驳回。审核不通过,需要重新创建并审核;
  • 5:欠费关停。

Type

String

push

域名类型,包含两种类型。

  • push:推流域名;
  • pull-flv:拉流域名,包含 RTMP、FLV、HLS 格式。

Region

String

cn

区域,包含 4 种类型。

  • cn:中国大陆;
  • oversea:海外;
  • cn-global:全球;
  • cn-oversea:海外及港澳台。
CNameStringpush.example.com.bytefcdn.comCname 信息。

CnameCheck

Integer

0

Cname 状态。

  • 0:未配置 CNAME;
  • 1:已配置 CNAME。

DomainCheck

Integer

0

域名是否可用的状态。

  • 0:正常,域名为可用状态;
  • 1:配置中,域名为可用状态;
  • 2:不可用,域名为其他的不可用状态。
ICPCheckInteger0IPC 备案校验是否通过,是否过期信息。
CreateTimeString2006-01-02T15:04:05+08:00创建时间。
CertDomainString*.example.com所绑定证书支持的泛域名。
ChainIDString21614绑定的证书信息。
PushDomainStringpush.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"
            }
        ]
    }
}

错误码

访问公共错误码获取详细信息。