最近更新时间:2023.10.12 11:03:37
首次发布时间:2022.03.31 15:59:02
此接口用于获取空间域名列表。通过 SpaceName
获取空间域名下的信息。
请求频率:单用户请求频率限制为 10 次/秒。
请求地址:https://vod.volcengineapi.com?Action=ListDomain&Version=2023-01-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListDomain | 接口名称。当前 API 的名称为 ListDomain 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
SpaceName | String | 是 |
| 点播空间名。您可通过以下方式获取空间名称: |
DomainType | String | 否 |
| 域名类型。取值如下:
注意
|
SourceStationType | Integer | 否 |
| 源站类型。取值如下:
|
Offset | Integer | 否 | 0 | 确认分页结果。如果传 0,默认获取第一页。默认为每页大小为 10 条域名结果。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SpaceName | String | test | 点播空间名。 |
PlayInstanceInfo | Object of PlayInstanceInfo | - | 播放域名信息。 |
ImageInstanceInfo | Object of ImageInstanceInfo | - | 封面域名信息。 |
DefaultPlayDomain | String | 默认播放域名。 | |
Total | Long | 1 | 符合要求的域名总数。 |
Offset | Long | 1 | 返回的域名数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ByteInstances | Array of Instance | - | 回源点播加速域名信息。 |
OtherInstances | Array of Instance | - | 回源自定义源站加速域名信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ByteInstances | Array of Instance | - | 回源点播加速域名信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domains | Array of Domains | - | 域名列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | test.com | 域名。 |
Cname | String | test.com.bytevdn.com | CNAME 域名。 |
ConfigStatus | String |
| 配置状态。取值如下:
|
CnameStatus | String |
| 解析状态。取值如下:
|
Status | String |
| 运行状态。取值如下:
|
Certificate | Object of Certificate | - | 证书。 |
CreateTime | String | 2022-12-08T19:51:07+08:00 | 创建时间。UTC + 8 时区。 |
UpdateTime | String | 2023-04-23T15:41:00+08:00 | 更新时间。UTC + 8 时区。 |
Region | String |
| 加速区域。取值如下:
|
Sources | Array of Sources | - | 源站信息。 |
LockStatus | String |
| 是否锁定。取值如下:
|
CDNStatus | String |
| CDN 状态。 取值如下:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
CertificateId | String | cert_hosting-7269 | 证书 ID。 |
ExpiredAt | String | 2023-07-23T07:59:59+08:00 | 过期时间。UTC + 8 时区。 |
HttpsStatus | String |
| HTTPS 状态。取值如下:
|
CertificateCenterCertificateId | String | cert-xxxx | 证书中心的证书 ID。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SourceStationType | Integer |
| 源站类型。取值如下:
|
SourceStationAddressType | Integer |
| 源站地址类型。取值如下:
|
Origin | String | 回源地址。 | |
Bucket | Object of Bucket | - | 回源存储桶信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
BucketName | String | 回源桶名称。 | |
BucketSourceType | String |
| 回源存储源类型。取值如下:
|
BucketRegion | String | 回源桶区域。 |
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 | 无效的域名类型或源站类型,请调整后重试。 |
点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API,此 API 各语言调用的示例代码,请参考如下: