文档中心

查询域名信息

最近更新时间：2024.03.27 17:13:23

首次发布时间：2023.09.25 14:31:21

调用 DescribeDomain 接口，查询域名的详细信息，包括但不限于域名所属域名空间、CNAME、类型、域名状态。

注意事项

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

请求说明

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

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeDomain`	接口名称。当前 API 的名称为 `DescribeDomain`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	是	`["push.example.com","pull.example.com"]`	待查询域名信息的域名列表。

返回参数

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

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

DomainList

参数	类型	示例值	描述
Vhost	String	`push.example.com`	域名空间。
Domain	String	`push.example.com`	推/拉流域名。
Status	Integer	`0`	域名状态。状态说明如下所示。 `0`：正常； `1`：审核中； `2`：禁用，禁止使用，此时域名加速不生效； `3`：删除； `4`：审核被驳回，审核不通过，需要重新创建并审核； `5`：欠费关停。
Type	String	`push`	域名类型，包含两种类型。 `push`：推流域名； `pull-flv`：拉流域名，包含 RTMP、FLV、HLS 格式。
Region	String	`cn`	域名加速区域，包含以下类型。 `cn`：中国大陆； `cn-global`：全球； `cn-oversea`：海外及港澳台。
CNAME	String	`push.example.com.bytefcdn.com`	CNAME 信息。
CnameCheck	Integer	`0`	CNAME 状态。 `0`：未配置 CNAME； `1`：已配置 CNAME。
DomainCheck	Integer	`0`	域名是否可用的状态。 `0`：正常，域名为可用状态； `1`：配置中，域名为可用状态； `2`：不可用，域名为其他的不可用状态。
ICPCheck	Integer	`0`	ICP 备案校验是否通过，是否过期信息。 1：备案正常，未过期； 2：查存不到备案信息。
CreateTime	String	`2006-01-02T15:04:05Z`	域名添加时间，RFC3339 格式的 UTC 时间戳，精度为秒。
CertDomain	String	`*.example.com`	绑定的 HTTPS 证书支持的泛域名。
ChainID	String	`21614`	绑定的 HTTPS 证书的证书链 ID 信息。
PushDomain	String	`push.example.com`	当前域名所属的域名空间下的推流域名。

请求示例

POST https://live.volcengineapi.com?Action=DescribeDomain&Version=2023-01-01
{
  "DomainList": [
    "push.example.com"
  ]
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"DescribeDomain",
        "Version":"2023-01-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:05Z"
            }
        ]
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.DB	an internal error related to database occurred, please contact the administrator.	出现与数据库相关的内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。