You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询域名列表

最近更新时间：2023.11.21 15:39:42

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

我的收藏

调用 ListDomainDetail 接口，根据域名状态、类别等信息，过滤查询当前账号下的的域名列表信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListDomainDetail接口名称。当前 API 的名称为 ListDomainDetail。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
PageNumInteger是1当前页码，取值范围为 [1,1000]。
PageSizeInteger是10分页大小，取值范围为 [1, 1000]
VhostListArray of String否["push.example.com","pull.example.com"]域名空间列表，缺省情况下表示全部。

DomainStatusList

Array of Integer

否

[0,2,3]

域名状态列表。缺省情况下表示全部。支持的取值如下所示。

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

DomainTypeList

Array of String

否

["push","pull-flv"]

域名类型列表。缺省情况下表示全部。域名类型支持以下取值。

  • push：推流域名；
  • pull-flv：拉流域名。

DomainRegionList

Array of String

否

["cn"]

域名区域列表。缺省情况下表示全部，区域类型支持以下取值。

  • cn：中国大陆；
  • cn-global：全球；
  • cn-oversea：海外及港澳台。
DomainNameListArray of String否["push.example.com","pull.example.com"]域名名称列表，缺省情况下表示全部。

返回参数

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

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

DomainList

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

Status

Integer

0

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

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

Type

String

pull

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

  • push：推流域名；
  • pull-flv：拉流域名，包含 RTMP、FLV、HLS 格式。

Region

String

cn

区域，包含 4 种类型。

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

CnameCheck

Integer

0

CNAME 状态。

  • 0：未配置 CNAME；
  • 1：已配置 CNAME。

DomainCheck

Integer

0

域名是否可用的状态。

  • 0：正常，域名为可用状态；
  • 1：配置中，域名为可用状态；
  • 2：不可用，域名为其他的不可用状态。
ICPCheckInteger1IPC 备案校验是否通过，是否过期信息。
CreateTimeString2006-01-02T15:04:05+08:00创建时间。
CertDomainString*.example.com所绑定证书支持的泛域名。
ChainIDString21614绑定的证书信息。
PushDomainStringpush.example.com绑定的推流域名。
ProjectNameStringdefault项目名称
TagsArray of Tags-标签

Tags

参数类型示例值描述
KeyStringkey1标签 key。
ValueStringvalue1标签 value。
CategoryStringCustom分类。

示例

请求示例

POST https://live.volcengineapi.com?Action=ListDomainDetail&Version=2023-01-01

{
  "DomainTypeList": [
    "pull-flv",
    "push"
  ],
  "PageNum": 1,
  "PageSize": 10
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"ListDomainDetail",
        "Version":"2023-01-01",
        "Service":"live",
        "Region": "cn-north-1"
    }
    "Resutl": { 
        "DomainList": [
            {
                "Domain": "push.example.com",
                "Status": 0,
                "Type": "push",
                "Region": "cn",
                "CName": "push.example.com.bytefcdn.com",
                "CnameCheck":0,
                "DomainCheck":0,
                "CreateTime":"2006-01-02T15:04:05+08:00"
            },
            {
                "Domain": "pull.example.com",
                "Status": 0,
                "Type": "pull",
                "Region": "cn",
                "CName": "pull.example.com.bytefcdn.com",
                "CnameCheck":0,
                "DomainCheck":0,
                "CreateTime":"2006-01-02T15:04:05+08:00"
            }
        ],
        "Total": 2 
    }
}

错误码

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

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