You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/点播 CDN/域名管理/获取空间域名列表
获取空间域名列表
最近更新时间：2024.06.25 12:54:27首次发布时间：2022.03.31 15:59:02
我的收藏

此接口用于在指定空间下，设置域名类别、源站类型等参数，获取空间下域名的信息。

注意事项

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

请求说明

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

调试

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

请求参数

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

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

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

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

域名类型。取值如下：

  • play：播放域名
  • image：封面域名
SourceStationType
Integer
否
1

源站类型。取值如下：

  • 1：点播源站。
  • 2：自定义源站
Offset
Integer
否
0

设置跨域名页数。传 0 表示获取第一页。每页大小默认为 10 条域名结果。

注意

DomainType、SourceStationType和 Offset 所传参数不同，获取的域名信息也不同，区别如下：

  • （推荐）同时传，会分页获取域名信息。每页最多返回 10 条域名的详细信息。
  • 传部分参数，会获取空间下所有域名信息，不分页。如果空间下域名太多，会导致超时报错。

返回参数

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

参数
类型
示例值
描述
SpaceName
String
test
点播空间名。
PlayInstanceInfo
Object
-
播放域名信息。
ByteInstances
Object[]
-
回源点播加速域名信息。
Domains
Object[]
-
域名列表。
Domain
String
test.com
域名。
Cname
String
test.com.bytevdn.com
CNAME 域名。
ConfigStatus
String
enable

配置状态。取值如下：

  • enable：开启。
  • disable：关闭。
CnameStatus
String
enable

解析状态。取值如下：

  • enable：成功。
  • disable：失败。
Status
String
enable

运行状态。取值如下：

  • enable：运行中。
  • disable：停用。
Certificate
Object
-
证书。
CertificateId
String
cert_hosting-7269
证书 ID。
HttpsStatus
String
enable

HTTPS 状态。取值如下：

  • enable：开启。
  • configuring：配置中。
ExpiredAt
String
2023-07-23T07:59:59+08:00
证书过期时间，遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
CertificateCenterCertificateId
String
cert-xxxx
证书中心证书 ID。
CreateTime
String
2022-12-08T19:51:07+08:00
创建时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
UpdateTime
String
2023-04-23T15:41:00+08:00
更新时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
Region
String
cn

加速区域。取值如下：

  • cn：国内。
  • overseas：海外。
  • global：全球。
Sources
Object[]
-
源站信息。
SourceStationType
String
1

源站类型。取值如下：

  • 1：点播加速域名。
  • 2：自定义源站加速域名。
SourceStationAddressType
String
1

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

  • 1：域名类型源站。
  • 2：IP 类型源站。
Origin
String
http://example.com
回源地址。
Bucket
Object
-
回源存储桶信息。
BucketName
String
example
回源桶名称。
BucketSourceType
String
vod

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

  • vod：点播存储。
  • tos：挂载对象存储。
BucketRegion
String
***
回源桶区域。
LockStatus
String
off

是否锁定。取值如下：

  • off：未锁定。
  • on：锁定。
CdnStatus
String
disable

CDN 状态。 取值如下：

  • enable：启用。
  • disable：停用。
OtherInstances
Object[]
-
回源自定义源站加速域名信息。
Domains
Object[]
-
域名列表。
Domain
String
test.com
域名。
Cname
String
test.com.bytevdn.com
CNAME 域名。
ConfigStatus
String
enable

配置状态。取值如下：

  • enable：开启。
  • disable：关闭。
CnameStatus
String
enable

解析状态。取值如下：

  • enable：成功。
  • disable：失败。
Status
String
enable

运行状态。取值如下：

  • enable：运行中。
  • disable：停用。
Certificate
Object
-
证书。
CertificateId
String
cert_hosting-7269
证书 ID。
HttpsStatus
String
enable

HTTPS 状态。取值如下：

  • enable：开启。
  • configuring：配置中。
ExpiredAt
String
2023-07-23T07:59:59+08:00
证书过期时间，遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
CertificateCenterCertificateId
String
cert-xxxx
证书中心证书 ID。
CreateTime
String
2022-12-08T19:51:07+08:00
创建时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
UpdateTime
String
2023-04-23T15:41:00+08:00
更新时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
Region
String
cn

加速区域。取值如下：

  • cn：国内。
  • overseas：海外。
  • global：全球。
Sources
Object[]
-
源站信息。
SourceStationType
String
1

源站类型。取值如下：

  • 1：点播加速域名。
  • 2：自定义源站加速域名。
SourceStationAddressType
String
1

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

  • 1：域名类型源站。
  • 2：IP 类型源站。
Origin
String
http://example.com
回源地址。
Bucket
Object
-
回源存储桶信息。
BucketName
String
example
回源桶名称。
BucketSourceType
String
vod

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

  • vod：点播存储。
  • tos：挂载对象存储。
BucketRegion
String
***
回源桶区域。
LockStatus
String
off

是否锁定。取值如下：

  • off：未锁定。
  • on：锁定。
CdnStatus
String
disable

CDN 状态。 取值如下：

  • enable：启用。
  • disable：停用。
ImageInstanceInfo
Object
-
封面域名信息。
ByteInstances
Object[]
-
回源点播加速域名信息。
Domains
Object[]
-
域名列表。
Domain
String
test.com
域名。
Cname
String
test.com.bytevdn.com
CNAME 域名。
ConfigStatus
String
enable

配置状态。取值如下：

  • enable：开启。
  • disable：关闭。
CnameStatus
String
enable

解析状态。取值如下：

  • enable：成功。
  • disable：失败。
Status
String
enable

运行状态。取值如下：

  • enable：运行中。
  • disable：停用。
Certificate
Object
-
证书。
CertificateId
String
cert_hosting-7269
证书 ID。
HttpsStatus
String
enable

HTTPS 状态。取值如下：

  • enable：开启。
  • configuring：配置中。
ExpiredAt
String
2023-07-23T07:59:59+08:00
证书过期时间，遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
CertificateCenterCertificateId
String
cert-xxxx
证书中心证书 ID。
CreateTime
String
2022-12-08T19:51:07+08:00
创建时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
UpdateTime
String
2023-04-23T15:41:00+08:00
更新时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
Region
String
cn

加速区域。取值如下：

  • cn：国内。
  • overseas：海外。
  • global：全球。
Sources
Object[]
-
源站信息。
SourceStationType
String
1

源站类型。取值如下：

  • 1：点播加速域名。
  • 2：自定义源站加速域名。
SourceStationAddressType
String
1

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

  • 1：域名类型源站。
  • 2：IP 类型源站。
Origin
String
http://example.com
回源地址。
Bucket
Object
-
回源存储桶信息。
BucketName
String
example
回源桶名称。
BucketSourceType
String
vod

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

  • vod：点播存储。
  • tos：挂载对象存储。
BucketRegion
String
***
回源桶区域。
LockStatus
String
off

是否锁定。取值如下：

  • off：未锁定。
  • on：锁定。
CdnStatus
String
disable

CDN 状态。 取值如下：

  • enable：启用。
  • disable：停用。
OtherInstances
Object[]
-
回源自定义源站加速域名信息。
Domains
Object[]
-
域名列表。
Domain
String
test.com
域名。
Cname
String
test.com.bytevdn.com
CNAME 域名。
ConfigStatus
String
enable

配置状态。取值如下：

  • enable：开启。
  • disable：关闭。
CnameStatus
String
enable

解析状态。取值如下：

  • enable：成功。
  • disable：失败。
Status
String
enable

运行状态。取值如下：

  • enable：运行中。
  • disable：停用。
Certificate
Object
-
证书。
CertificateId
String
cert_hosting-7269
证书 ID。
HttpsStatus
String
enable

HTTPS 状态。取值如下：

  • enable：开启。
  • configuring：配置中。
ExpiredAt
String
2023-07-23T07:59:59+08:00
证书过期时间，遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
CertificateCenterCertificateId
String
cert-xxxx
证书中心证书 ID。
CreateTime
String
2022-12-08T19:51:07+08:00
创建时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
UpdateTime
String
2023-04-23T15:41:00+08:00
更新时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为 yyyy-MM-dd HH:mm:ss。
Region
String
cn

加速区域。取值如下：

  • cn：国内。
  • overseas：海外。
  • global：全球。
Sources
Object[]
-
源站信息。
SourceStationType
String
1

源站类型。取值如下：

  • 1：点播加速域名。
  • 2：自定义源站加速域名。
SourceStationAddressType
String
1

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

  • 1：域名类型源站。
  • 2：IP 类型源站。
Origin
String
http://example.com
回源地址。
Bucket
Object
-
回源存储桶信息。
BucketName
String
example
回源桶名称。
BucketSourceType
String
vod

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

  • vod：点播存储。
  • tos：挂载对象存储。
BucketRegion
String
***
回源桶区域。
LockStatus
String
off

是否锁定。取值如下：

  • off：未锁定。
  • on：锁定。
CdnStatus
String
disable

CDN 状态。 取值如下：

  • enable：启用。
  • disable：停用。
DefaultPlayDomain
String
www.example.vod.com
默认播放域名。
Total
Integer
1
符合要求的域名总数。
Offset
Integer
1
返回的域名数量。

请求示例

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"
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码错误码错误信息说明
400InvalidParameter.InvalidAccountId-无效的账号 ID，请调整后重试
400InvalidParameter.InvalidDomainTypeOrSourceStationType-无效的域名类型或源站类型，请调整后重试。

服务端 SDK

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