获取加速域名列表--多云CDN-火山引擎

文档中心

立即注册

导航

获取加速域名列表

最近更新时间：2024.12.19 15:35:27首次发布时间：2022.12.29 10:10:02

调用本接口获取加速域名列表。加速域名包含您添加到内置CDN加速的域名，以及从第三方云服务商平台同步的加速域名。

使用说明

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

使用限制

节流限制：您每秒最多可以提交 30 个 API 请求。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListCdnDomains&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `ListCdnDomains`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Name	String	否	指定一个加速域名，查询与该域名模糊匹配的加速域名的信息。	`www.example.com`
CdnType	String[]	否	指定一个或多个业务类型，查询具有该业务类型属性的加速域名。该参数有以下取值： `Download`：大文件下载加速 `Video`：音视频点播加速 `Web`：网页/小文件加速 `Dynamic`：动态与静态内容混合加速 `Live`：直播加速 `Default`：未配置	`Download`
Vendor	String[]	否	指定一个或多个云服务商，查询属于指定云服务商的加速域名。该参数有以下取值： `builtin`：内置加速 `aliyun`：阿里云 `tencent`：腾讯云 `ksyun`：金山云 `huawei`：华为云 `volcengine`：火山引擎 `wangsu`：网宿科技 `qiniu`：七牛云 `ucloud`：UCloud `akamai`：Akamai `baishan`：白山云 `aws`：AWS `baidu`：百度智能云 `jingdong`：京东云 `gcp`：Google Cloud `chinamobile`：中国移动 `ctcdn`：天翼云CDN+ `azure`：Azure	`volcengine`
Status	String[]	否	指定一个或多个状态，查询处于指定状态的加速域名。该参数有以下取值： `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`
Pagination	Object	否	对查询结果进行分页并返回特定页码上的加速域名。
BizNodeIds	String[]	否	指定一个或多个多云CDN业务节点的 ID，查询属于指定业务的加速域名。 “业务”是多云CDN用来对资源进行分组和权限管理的工具。更多信息，请参见权限管理。	`65098b4f78287dcda3be****`
TagFilters	Object[]	否	指定一个或多个标签，查询与指定标签关联的加速域名。多个标签之间使用“逻辑与”方式连接（即与所有标签都匹配才算满足条件）。
ScheduleCreated	Boolean	否	是否只查询开启多云流量调度的域名。默认值为 `false`。	`false`

返回参数

参数名称	数据类型	参数说明	示例
Domains	Object[]	加速域名信息列表。
Pagination	Object	分页信息。

请求示例

POST https://open.volcengineapi.com/?Action=ListCdnDomains&Version=2022-03-01&<其他公共请求参数>=
{
    "Pagination": {
        "PageSize": 10,
        "PageNum": 1
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202403041943087426E2A3AAE3A8F7524B",
        "Action": "ListCdnDomains",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Domains": [
            {
                "Id": "654a20acbd82bac3e2c6****",
                "Name": "www.example.com",
                "Cname": "www.example.com.volcgslb.com",
                "Status": "Online",
                "CdnType": "Web",
                "Vendor": "volcengine",
                "Region": "Domestic",
                "TopAccountId": "210023XXXX",
                "CloudAccountId": "6596badbd262c2b7220b****",
                "CloudAccountName": "volctest",
                "Tags": null,
                "SubProduct": "cdn",
                "ScheduleCreated": true,
                "VendorId": "aeadf2de79d04f6794704922190c****",
                "VendorCdnType": "web",
                "CreatedAt": "2022-08-02T10:28:13Z",
                "UpdatedAt": "2024-01-10T18:30:29Z",
                "Certificates": [
                    {
                        "Id": "mcdntest",
                        "Name": "mcdntest",
                        "StartTime": "2023-06-30T08:00:00+08:00",
                        "ExpireTime": "2024-06-30T07:59:59+08:00",
                        "FingerprintSha1": "fe357a975e25f1a536c56c77f852399b423b8727",
                        "FingerprintSha256": "5b9566783da171972c46c74a35d5aa50f13fd40290c69b5a383fb5b061c72f1a",
                        "CommonName": "*.example.com",
                        "SubjectAlternativeNames": [
                            "*.example.com",
                            "example.com"
                        ],
                        "Status": "Ok",
                        "SyncDetail": {
                            "SyncedAt": "2024-03-04T19:02:10+08:00"
                        },
                        "VolcIds": [
                            "cert-0dc7e5dfbf954bf2952ea98746fd****"
                        ],
                        "VolcIdsSyncDetail": {
                            "SyncedAt": "2024-03-04T19:02:10+08:00"
                        }
                    }
                ],
                "Networks": [
                    {
                        "Type": "Cname",
                        "Value": "www.example.com.volcgslb.com"
                    }
                ],
                "BizNodeId": "65098b4f78287dcda3be****",
                "BizNodeName": "未分组",
                "BizNodePath": "/未分组",
                "SyncStatus": "Success",
                "SyncedAt": "2024-01-11T17:26:02+08:00",
                "ImportedAt": "2023-11-07T19:33:58+08:00",
                "ConfigSyncDetail": {
                    "SyncedAt": "2024-01-11T17:26:07+08:00"
                }
            }
        ],
        "Pagination": {
            "PageSize": 10,
            "PageNum": 1,
            "Total": 1
        }
    }
}

错误码

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