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

获取全局配置列表

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

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

我的收藏

API 说明

API 名称：ListSharedConfig。
API 域名：cdn.volcengineapi.com。
API 描述：获取已有的全局配置列表。该 API 是白名单功能。要使用该 API，请 提交工单。

使用限制

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

请求说明

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

请求参数

Query

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

Body

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

指定一个全局配置的类型，获取该类型的全局配置列表。该参数有以下取值：

  • deny_ip_access_rule：表示 IP 黑名单。
  • allow_ip_access_rule：表示 IP 白名单。
  • 4xx_error_page: 表示自定义错误页面。
  • deny_referer_access_rule：表示 Referer 黑名单。
  • allow_referer_access_rule：表示 Referer 白名单。
  • common_match_list：表示通用列表。
allow_ip_access_rule
PageNum
Long
否

指定页码以获取该页上的全局配置。

内容分发网络对该 API 返回的全局配置列表根据 PageSize 进行分页。假设该 API 返回的全局配置的数量是 100，PageSize 是 10，那么返回的全局配置是分布在 10 个页上。

该参数的默认值是 1。
1
PageSize
Long
否

指定每页包含的全局配置数量。

该参数的取值范围是 1-1,000，默认值是 10。
10
Project
String
否
指定一个项目名称，获取归属该项目的全局配置。
default
ConfigTypeList
String[]
否
指定一个或多个全局配置的类型，获取这些类型的全局配置列表。该参数值可以是 ConfigType 可用值的组合。ConfigType 与 ConfigTypeList 不能同时指定。
["allow_ip_access_rule","deny_ip_access_rule"]

返回参数

参数名称
数据类型
参数说明
示例
ConfigData
Object[]
表示符合查询条件的全局配置列表。
PageNum
Long
表示您在请求中指定的 PageNum。
1
PageSize
Long
表示您在请求中指定的 PageSize。
10
Total
Long
表示符合查询条件的全局配置总数。
20

请求示例

POST https://cdn.volcengineapi.com/?Action=ListSharedConfig&Version=2021-03-01
{
    "ConfigType":"allow_ip_access_rule"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240117195639014D4059167D42B2C640",
        "Action": "ListSharedConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "ConfigData": [
            {
                "ConfigName": "deny_ip",
                "ConfigType": "deny_ip_access_rule",
                "DomainCount": 0,
                "Project": "default",
                "UpdateTime": 1705492181
            },
            {
                "ConfigName": "error_page",
                "ConfigType": "4xx_error_page",
                "DomainCount": 1,
                "Project": "default",
                "UpdateTime": 1705334019
            },
            {
                "ConfigName": "common_list",
                "ConfigType": "common_match_list",
                "DomainCount": 0,
                "Project": "default",
                "UpdateTime": 1705332721
            },
            {
                "ConfigName": "deny_referer",
                "ConfigType": "deny_referer_access_rule",
                "DomainCount": 3,
                "Project": "default",
                "UpdateTime": 1702484378
            }
        ],
        "PageNum": 1,
        "PageSize": 10,
        "Total": 34
    }
}