You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /
  • 内容分发网络

创建全局配置

最近更新时间：2024.02.26 16:31:18

首次发布时间：2024.01.19 14:11:20

我的收藏

API 说明

API 名称：AddSharedConfig。
API 域名：cdn.volcengineapi.com。
API 描述：创建一个全局配置。该 API 是白名单功能。要使用该 API，请 提交工单。

使用限制

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

请求说明

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

公共参数

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

Body

基本参数

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

表示全局配置的名称。名称有以下要求：

  • 名称可以包含汉字、字母、数字、下划线（_），长度在 3-45 个字符之间。一个汉字占 3 个字符。
  • 名称不能与主账号下某个已有的全局配置的名称相同。
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：表示通用列表。
allow_ip_access_rule
Project
String
否

表示该全局配置所归属的项目名称，默认值是 default。

您可以访问 项目管理 查看已创建的项目以及每个项目包含的资源。
default

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。

返回参数

无。

请求示例

POST https://cdn.volcengineapi.com/?Action=AddSharedConfig&Version=2021-03-01
{
    "ConfigName":"My_List",
    "ConfigType":"allow_referer_access_rule",
    "AllowRefererAccessRule":{
        "CommonType": {
            "Rules":[
                "1.1.1.1",
                "www.example.com",
                "*.test.com"
            ]
        }
    }
}

返回示例