You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /内容分发网络/API 参考/配置操作接口/全局配置/查询全局配置详情
查询全局配置详情
最近更新时间：2024.12.02 11:02:38首次发布时间：2024.01.19 14:11:51
我的收藏

API 说明

API 名称：DescribeSharedConfig。
API 域名：cdn.volcengineapi.com。
API 描述：获取一个全局配置的设置。要使用该 API，请 提交工单。

使用限制

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

请求说明

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

公共参数

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

请求正文参数

基本参数

参数名称
数据类型
是否必选
参数说明
示例
ConfigName
String
否
表示一个全局配置的名称。
my_whitelist

返回参数

基本参数

参数名称
数据类型
参数说明
示例
ConfigName
String
表示该全局配置的名称。
my_whitelist
ConfigType
String

表示该全局配置的类型。该参数有以下取值：

  • deny_ip_access_rule：表示 IP 黑名单。
  • allow_ip_access_rule：表示 IP 白名单。
  • deny_referer_access_rule：表示 Referer 黑名单。
  • allow_referer_access_rule：表示 Referer 白名单。
  • common_match_list：表示通用列表。
  • 4xx_error_page: 表示自定义错误页面。
allow_ip_access_rule
Project
String
表示该全局配置所归属的项目名称。
default
除了基本参数，该 API 还返回与该全局配置的类型相对应的其他参数。

IP 白名单

参数名称
数据类型
参数说明
示例
AllowIpAccessRule
Object
表示 IP 白名单的配置，对应 ConfigType 是 allow_ip_access_rule。

IP 黑名单

参数名称
数据类型
参数说明
示例
DenyIpAccessRule
Object
表示 IP 黑名单的配置，对应 ConfigType 是 deny_ip_access_rule。

Referer 白名单

参数名称
数据类型
参数说明
示例
AllowRefererAccessRule
Object
表示 Referer 白名单的配置，对应 ConfigType 是 allow_referer_access_rule。

Referer 黑名单

参数名称
数据类型
参数说明
示例
DenyRefererAccessRule
Object
表示 Referer 黑名单的配置，对应 ConfigType 是 deny_referer_access_rule。

通用列表

参数名称
数据类型
参数说明
示例
CommonMatchList
Object
表示通用列表的配置，对应 ConfigType 是 common_match_list。

自定义错误页面

参数名称
数据类型
参数说明
示例
ErrorPageRule
Object
表示自定义错误页面的配置。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240117195526014D4059167D42B29F80",
        "Action": "DescribeSharedConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "ConfigName": "jknk",
        "ConfigType": "allow_referer_access_rule",
        "DenyRefererAccessRule": {
            "AllowEmpty": true,
            "CommonType": {
                "IgnoreCase": true,
                "Rules": [
                    "xx.xxx.xxx.xxx",
                    "*.example.com",
                    "aaa.example.com"
                ]
            }
        },
        "Project": "default"
    }
}

错误码

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