修改全局配置--内容分发网络-火山引擎

文档中心

立即注册

导航

修改全局配置

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

API 说明

API 名称：UpdateSharedConfig。
API 域名：cdn.volcengineapi.com。
API 描述：修改一个全局配置。要使用该 API，请提交工单。

使用限制

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

请求说明

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

公共参数

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

请求正文参数

基本参数

参数名称	数据类型	是否必选	参数说明	示例
ConfigName	String	是	表示一个全局配置的名称。您可以调用 ListSharedConfig 获取已有的全局配置名称。	`MySharedConfig`

基于您指定的 ConfigName 的类型，您还需要配置以下对应的参数。您可以调用 DescribeSharedConfig 获取该全局配置的类型。

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`。

返回参数

由于该 API 没有响应参数，响应正文只有包含请求元数据的 ResponseMetadata 结构体，没有 Result 结构体。

请求示例

POST https://cdn.volcengineapi.com/?Action=UpdateSharedConfig&Version=2021-03-01
{
    "ConfigName": "My_List",
    "DenyRefererAccessRule": {
        "CommonType": { 
            "Option": "add",
            "Rule": [
                "xx.xxx.xxx.xx",
                "xxx.xxx.xxx.xx"
            ]
        }
    }
}

返回示例

错误码

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