获取全局配置关联的加速域名--内容分发网络-火山引擎

文档中心

立即注册

导航

获取全局配置关联的加速域名

最近更新时间：2024.12.02 11:02:38首次发布时间：2024.01.19 14:11:58

API 说明

API 名称：DescribeDomainShared。
API 域名：cdn.volcengineapi.com。
API 描述：指定一个全局配置，获取该全局配置所关联的加速域名。要使用该 API，请提交工单。

使用限制

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

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=DescribeDomainShared&Version=2021-03-01

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
ConfigName	String	否	表示一个全局配置的名称，用来获取与该全局配置关联的加速域名。	`my_whitelist`

返回参数

参数名称	数据类型	参数说明	示例
ConfigName	String	表示该全局配置的名称。	`my_whitelist`
Domain	String[]	表示一个与该全局配置关联的加速域名列表。如果该全局配置还未与任何域名关联，该参数值为一个空数组。当调用该 API 时，如果子账号没有权限访问某个与该全局配置关联的加速域名，该加速域名不会出现在 `Domain` 列表中。	`["example.com","www.example.com"]`

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeDomainShared&Version=2021-03-01
{
    "ConfigName":"my_whitelist"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211202162625010211175223170002CD", 
        "Action": "DescribeDomainShared", 
        "Version": "2021-03-01", 
        "Service": "CDN", 
        "Region": "cn-north-1"
    }, 
    "Result": {
        "ConfigName":"my_whitelist",
        "Domain": ["example.com","www.example.com"]
    }
}

错误码

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