You need to enable JavaScript to run this app.
导航

获取空间域名列表

最近更新时间2023.10.12 11:03:37

首次发布时间2022.03.31 15:59:02

此接口用于获取空间域名列表。通过 SpaceName 获取空间域名下的信息。

注意事项

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

请求说明

请求地址:https://vod.volcengineapi.com?Action=ListDomain&Version=2023-01-01

请求参数

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

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

SpaceName

String

tT

点播空间名。您可通过以下方式获取空间名称:

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。

DomainType

String

play

域名类型。取值如下:

  • play:播放域名
  • image:封面域名

注意

DomainTypeSourceStationTypeOffset 所传参数不同,获取的域名信息也不同,区别如下:

  • (推荐)同时传,会分页获取域名信息。
  • 同时不传,会获取空间下所有域名信息;如果空间下域名太多,会报错。
  • 传部分参数,也会报错。

SourceStationType

Integer

1

源站类型。取值如下:

  • 1:(默认)点播源站。
  • 2:自定义源站
OffsetInteger0确认分页结果。如果传 0,默认获取第一页。默认为每页大小为 10 条域名结果。

返回参数

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

参数类型示例值描述
SpaceNameStringtest点播空间名。
PlayInstanceInfoObject of PlayInstanceInfo-播放域名信息。
ImageInstanceInfoObject of ImageInstanceInfo-封面域名信息。
DefaultPlayDomainString默认播放域名。
TotalLong1符合要求的域名总数。
OffsetLong1返回的域名数量。

PlayInstanceInfo

参数类型示例值描述
ByteInstancesArray of Instance-回源点播加速域名信息。
OtherInstancesArray of Instance-回源自定义源站加速域名信息。

ImageInstanceInfo

参数类型示例值描述
ByteInstancesArray of Instance-回源点播加速域名信息。

Instance

参数类型示例值描述
DomainsArray of Domains-域名列表。

Domains

参数类型示例值描述
DomainStringtest.com域名。
CnameStringtest.com.bytevdn.comCNAME 域名。

ConfigStatus

String

enable

配置状态。取值如下:

  • enable:开启。
  • disable:关闭。

CnameStatus

String

enable

解析状态。取值如下:

  • enable:成功。
  • disable:失败。

Status

String

enable

运行状态。取值如下:

  • enable:运行中。
  • disable:停用。
CertificateObject of Certificate-证书。
CreateTimeString2022-12-08T19:51:07+08:00创建时间。UTC + 8 时区。
UpdateTimeString2023-04-23T15:41:00+08:00更新时间。UTC + 8 时区。

Region

String

cn

加速区域。取值如下:

  • cn:国内。
  • overseas:海外。
  • global:全球。
SourcesArray of Sources-源站信息。

LockStatus

String

off

是否锁定。取值如下:

  • off:未锁定。
  • on:锁定。

CDNStatus

String

disable

CDN 状态。 取值如下:

  • enable:启用。
  • disable:停用。

Certificate

参数类型示例值描述
CertificateIdStringcert_hosting-7269证书 ID。
ExpiredAtString2023-07-23T07:59:59+08:00过期时间。UTC + 8 时区。

HttpsStatus

String

enable

HTTPS 状态。取值如下:

  • enable:开启。
  • configuring:配置中。
CertificateCenterCertificateIdStringcert-xxxx证书中心的证书 ID。

Sources

参数类型示例值描述

SourceStationType

Integer

1

源站类型。取值如下:

  • 1:点播加速域名。
  • 2:自定义源站加速域名。

SourceStationAddressType

Integer

1

源站地址类型。取值如下:

  • 1:域名类型源站。
  • 2:IP 类型源站。
OriginString回源地址。
BucketObject of Bucket-回源存储桶信息。

Bucket

参数类型示例值描述
BucketNameString回源桶名称。

BucketSourceType

String

vod

回源存储源类型。取值如下:

  • vod:点播存储。
  • tos:挂载对象存储。
BucketRegionString回源桶区域。

示例

请求示例

GET_POST https://vod.volcengineapi.com?Action=ListDomain&Version=2023-01-01&DomainType=play&Offset=0&SourceStationType=1&SpaceName=tT


返回示例

{
  "ResponseMetadata": {
    "RequestId": "202305091949***C10BDBB631BF336",
    "Action": "ListDomain",
    "Version": "2023-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "SpaceName": "test",
    "PlayInstanceInfo": {
      "ByteInstances": [
        {
          "Domains": [
            {
              "Domain": "test.com",
              "Cname": "test.com.bytevdn.com",
              "ConfigStatus": "enable",
              "CnameStatus": "enable",
              "Status": "enable",
              "Certificate": {
                "CertificateId": "cert_hosting-7269",
                "CertificateCenterCertificateId": "cert-xxxx",
                "HttpsStatus": "enable",
                "ExpiredAt": "2023-07-23T07:59:59+08:00"
              },
              "CreateTime": "2022-12-08T19:51:07+08:00",
              "UpdateTime": "2023-04-23T15:41:00+08:00",
              "Sources": [
                {
                  "Bucket": {
                    "BucketSourceType": "vod"
                  }
                }
              ],
              "LockStatus": "off"
            }
          ]
        }
      ]
    },
    "Total": "1",
    "Offset": "1"
  }
}

错误码

下表列举了本接口特有的错误码。视频点播公共错误码,详见公共错误码

错误码说明
InvalidParameter.InvalidAccountId无效的账号 ID,请调整后重试。
InvalidParameter.InvalidDomainTypeOrSourceStationType无效的域名类型或源站类型,请调整后重试。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API,此 API 各语言调用的示例代码,请参考如下: