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

获取域名列表

最近更新时间2023.12.15 10:58:43

首次发布时间2022.12.29 10:10:02

API 说明

  • API 名称:ListCdnDomains
  • API 域名:open.volcengineapi.com
  • API 描述:获取您从云服务商 CDN 同步到多云CDN的加速域名列表。

使用限制

节流限制:您每秒最多可以发送 30 个 API 请求。

请求方法

POST

请求鉴权

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权

公共参数

公共参数包含在查询字符串中。

参数名称
数据类型
是否必选
参数说明
Action
String

表示 API 的名称。该参数的取值是 ListCdnDomains

Version
String

表示 API 的版本。该参数的取值是 2022-03-01

请求参数

表格中参数的类型是请求正文参数。

参数名称
数据类型
是否必选
参数说明
示例
Name
String

设置一个加速域名,查询该加速域名的信息。支持模糊查询。

www.example.com

CdnType
String[]

设置一个或多个业务类型,查询具有该业务类型属性的加速域名。这里的业务类型指加速域名在云服务商 CDN 中的业务类型。该参数有以下取值:

  • Download:大文件下载加速

  • Video:音视频点播加速

  • Web:网页/小文件加速

Download

Vendor
String[]

设置一个或多个云服务商,查询该云服务商下的加速域名。该参数有以下取值:

  • aliyun:阿里云

  • tencent:腾讯云

  • ksyun:金山云

  • huawei:华为云

  • volcengine:火山引擎

  • wangsu:网宿科技

  • qiniu:七牛云

  • ucloud:UCloud

  • akamai:Akamai

  • baishan:白山云

  • aws:AWS

  • baidu:百度智能云

  • jingdong:京东云

volcengine

Status
String[]

设置一个或多个状态,查询该状态下的加速域名。这里的状态指加速域名在云服务商 CDN 中的状态。该参数有以下取值:

  • Deleting:删除中

  • Deploying:部署中

  • DeployingFailed:部署失败

  • Locked:已封禁

  • Locking:封禁中

  • Offline:已停用

  • Online:已启用

  • ReviewFailed:审核失败

  • Reviewing:审核中

  • Stopping:停用中

Online

Region
String[]

设置一个或多个加速区域,查询具有该加速区域属性的加速域名。该参数有以下取值:

  • Domestic:中国内地

  • Global:全球

  • OverSea:全球(不含中国内地)

Domestic

CloudAccountId
String

设置一个云服务商账号的 ID,查询通过该账号同步的加速域名。

该账号 ID 是多云CDN为云服务商账号生成的唯一 ID。只用于多云CDN业务系统。您可以调用 ListCloudAccounts 查询所有云服务商账号的 ID。

6384318d9da76135cd03****

ExactName
String

设置一个加速域名,查询该加速域名的信息。仅支持精确搜索。

www.example.com

VolcProjects
String[]

设置 IAM 项目列表,查询属于指定项目的加速域名。

火山引擎使用项目对资源分组管理。您从云服务商 CDN 同步到多云CDN的加速域名默认属于 default 项目。您可以在访问控制控制台的 资源管理 > 项目 页面,修改资源所属项目。

如果不设置该参数,默认返回所有加速域名。

default

Pagination
Pagination

分页查询的参数。

1

响应正文

参数名称
数据类型
参数说明
示例值
Domains
Domains[]

加速域名信息列表。

Pagination
Pagination

分页信息。

示例

请求示例

POST https://open.volcengineapi.com/?Action=ListCdnDomains&Version=2022-03-01
{
    "Pagination":{
        "PageSize": 10,
        "PageNum": 1
    }
}

响应示例

{
    "ResponseMetadata": {
        "RequestID": "2022122814431255E6D34017AB9A844A99",
        "Action": "ListCdnDomains",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Domains": [
            {
                "Id": "6376eabaf1254e2fb50c****",
                "Name": "www.example.com",
                "Cname": "www.example.com.volcgslb.com",
                "Status": "Online",
                "CdnType": "Download",
                "Vendor": "volcengine",
                "Region": "Domestic",
                "TopAccountId": "210023****",
                "CloudAccountId": "6384318d9da76135cd03****",
                "CloudAccountName": "volcengine",
                "Tags": null,
                "SubProduct": "cdn",
                "BizNodeId": "6463926e01176e0b049c0390",
                "BizNodeName": "未分组",
                "BizNodePath": "/未分组",
                "SyncStatus": "Success",
                "SyncedAt": "2022-11-28T11:57:03+08:00"
            },
            {
                "Id": "6376e8c3c588ae8ca940****",
                "Name": "www.example.com",
                "Cname": "www.example.com.w.kunluncan.com",
                "Status": "Online",
                "CdnType": "Web",
                "Vendor": "aliyun",
                "Region": "Domestic",
                "TopAccountId": "210023****",
                "CloudAccountId": "6376e8be0b2233bf5431****",
                "CloudAccountName": "aliyun",
                "Tags": null,
                "SubProduct": "cdn",
                "BizNodeId": "6463926e01176e0b049c0390",
                "BizNodeName": "未分组",
                "BizNodePath": "/未分组",
                "SyncStatus": "Success",
                "SyncedAt": "2022-11-18T10:06:59+08:00"
            }
        ],
        "Pagination": {
            "PageSize": 10,
            "PageNum": 1,
            "Total": 2
        }
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段,则表示 API 请求失败。关于更多错误码的信息,参见错误码