You need to enable JavaScript to run this app.
文档中心
文档控制台
注册
内容分发网络

内容分发网络

复制全文
下载 pdf
UpdateCdnConfig - 修改加速域名配置
基础配置
复制全文
下载 pdf
基础配置

使用限制

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

请求说明

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

公共参数

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

请求正文参数

域名配置

参数名称
数据类型
是否必选
参数说明
示例
Domain
String
表示要修改配置的加速域名。
www.example.com

IPv6 加速

参数名称
数据类型
是否必选
参数说明
示例
IPv6
Object
表示 IPv6 配置。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "IPv6": {
        "Switch": false
    }
}

源站配置

参数名称
数据类型
是否必选
参数说明
示例
Origin
Object[]
表示源站配置。

请求示例 1:源站是 IP 地址

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "Origin": [
        {
            "OriginAction": {
                "OriginLines": [
                    {
                        "Address": "xxx.xx.xx.xxx",
                        "HttpPort": "80",
                        "HttpsPort": "443",
                        "InstanceType": "ip",
                        "OriginType": "primary",
                        "Weight": "10"
                    },
                    {
                        "Address": "xx.xx.xx.xx",
                        "HttpPort": "80",
                        "HttpsPort": "443",
                        "InstanceType": "ip",
                        "OriginType": "primary",
                        "Weight": "10"
                    }
                ]
            }
        }
    ]
}

请求示例 2:源站是腾讯云对象存储桶

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "Origin": [
        {
            "OriginAction": {
                "OriginLines": [
                    {
                        "Address": "bucketname.cos.region.myqcloud.com",
                        "InstanceType": "tos",
                        "OriginType": "primary",
                        "PrivateBucketAccess": true,
                        "PrivateBucketAuth": {
                            "Switch": true,
                            "AuthType": "cos",
                            "TosAuthInformation": {
                                "AccessKeyId": "xxxxxxxxxxxxxxxx",
                                "AccessKeySecret": "xxxxxxx"
                            }
                        }
                    }
                ]
            }
        }
    ]
}

请求示例 3:源站是火山引擎对象私有存储桶,CDN 使用跨服务授权方式访问存储桶

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "Origin": [
        {
            "OriginAction": {
                "OriginLines": [
                    {
                        "Address": "mybucket.tos-cn-beijing.volces.com",
                        "InstanceType": "tos",
                        "OriginType": "primary",
                        "PrivateBucketAccess": true,
                        "PrivateBucketAuth": {
                            "Switch": true,
                            "AuthType": "tos"
                        },
                        "Weight": "1"
                    }
                ]
            }
        }
    ]
}

请求示例 4:源站是火山引擎对象存储桶,CDN 使用 AccessKey 访问存储桶

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "Origin": [
        {
            "OriginAction": {
                "OriginLines": [
                    {
                        "Address": "mybucket.tos-cn-beijing.volces.com"
                        "InstanceType": "tos",
                        "OriginType": "primary",
                        "PrivateBucketAccess": true,
                        "PrivateBucketAuth": {
                            "Switch": true
                            "AuthType": "tos",
                            "TosAuthInformation": {
                                "AccessKeyId": "xxxxxxxxxxxxx",
                                "AccessKeySecret": "xxxxxxxxxxxxxxxxxx"
                            }
                        },
                        "Weight": "1",
                    }
                ]
            }
        }
    ]
}

条件源站

参数名称
数据类型
是否必选
参数说明
示例
ConditionalOrigin
Object
表示 "条件源站" 特性的配置。要使用此特性,请 提交工单

请求示例

POST https: //cdn.byteplusapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "ConditionalOrigin": {
        "Switch": true,
        "OriginRules": [
            {
                "Actions": {
                    "OriginLines": [
                        {
                            "OriginType": "primary",
                            "Address": "203.0.113.8",
                            "HttpPort": "80",
                            "HttpsPort": "443",
                            "OriginHost": "www.example.com",
                            "Weight": "1",
                            "InstanceType": "ip"
                        },
                        {
                            "OriginType": "primary",
                            "Address": "test.example.com",
                            "HttpPort": "80",
                            "HttpsPort": "443",
                            "Weight": "2",
                            "PrivateBucketAccess": false,
                            "InstanceType": "domain"
                        },
                        {
                            "OriginType": "primary",
                            "Address": "mybucket.tos-cn-beijing.volces.com",
                            "TosAuthInformation": {
                                "AccessKeyId": "xxxxxxxxx",
                                "AccessKeySecret": "xxxxxxx"
                            },
                            "Weight": "1",
                            "PrivateBucketAccess": true,
                            "InstanceType": "storage",
                            "BucketSource": "tos"
                        },
                        {
                            "OriginType": "backup",
                            "Address": "my-global-data.s3.us-east-1.amazonaws.com",
                            "HttpPort": "80",
                            "HttpsPort": "443",
                            "TosAuthInformation": {
                                "AccessKeyId": "xxxxxxxxxxxxx",
                                "AccessKeySecret": "xxxxxxxxxxxx",
                                "Region": "us-east-1"
                            },
                            "Weight": "1",
                            "PrivateBucketAccess": true,
                            "InstanceType": "storage",
                            "BucketSource": "aws_common"
                        },
                        {
                            "OriginType": "backup",
                            "Address": "cdn-aquarium-photos.oss-cn-shanghai.aliyuncs.com",
                            "HttpPort": "80",
                            "HttpsPort": "443",
                            "TosAuthInformation": {
                                "AccessKeyId": "xxxxxxxxxxxxxxx",
                                "AccessKeySecret": "xxxxxxxxxxxxxxx"
                            },
                            "Weight": "1",
                            "PrivateBucketAccess": true,
                            "InstanceType": "storage",
                            "BucketSource": "oss"
                        },
                        {
                            "OriginType": "backup",
                            "Address": "cdn-aquarium-photos.cos.ap-shanghai.myqcloud.com",
                            "HttpPort": "80",
                            "HttpsPort": "443",
                            "TosAuthInformation": {},
                            "Weight": "1",
                            "PrivateBucketAccess": false,
                            "InstanceType": "storage",
                            "BucketSource": "cos"
                        },
                        {
                            "OriginType": "backup",
                            "Address": "my-bucket.tos-cn-beijing.volces.com",
                            "HttpPort": "80",
                            "HttpsPort": "443",
                            "TosAuthInformation": {},
                            "Weight": "1",
                            "PrivateBucketAccess": true,
                            "InstanceType": "storage",
                            "BucketSource": "tos"
                        }
                    ]
                },
                "Condition": {
                    "IsGroup": true,
                    "Connective": "and",
                    "ConditionGroups": [
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Object": "path",
                                "Operator": "equal",
                                "Value": [
                                    "/a/b/c",
                                    "/d/e/f"
                                ]
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Object": "client_ip_operator",
                                "Operator": "belong",
                                "Value": [
                                    "CM",
                                    "CU",
                                    "CT",
                                    "CMTIETONG",
                                    "CBN",
                                    "CERNET",
                                    "DRPENG"
                                ]
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Object": "full_querystring",
                                "Operator": "regex_match",
                                "Value": [
                                    "^a{1,2}b(.*)g=val[1-3]"
                                ]
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Object": "directory",
                                "Operator": "equal",
                                "Value": [
                                    "/dir1/dir2/",
                                    "/dir1/dir3/"
                                ]
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Object": "filetype",
                                "Operator": "not_equal",
                                "Value": [
                                    "bmp",
                                    "txt"
                                ]
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Object": "client_ip",
                                "Operator": "equal",
                                "Value": [
                                    "198.51.100.25",
                                    "198.51.100.28"
                                ]
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Object": "client_ip",
                                "Operator": "belong",
                                "Value": [
                                    "HKG",
                                    "MAC"
                                ]
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Name": "param1",
                                "Object": "query_name",
                                "Operator": "equal",
                                "Value": [
                                    "param-value1",
                                    "param-value2"
                                ],
                                "Type": "querystring"
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Name": "param3",
                                "Object": "query_name",
                                "Operator": "not_exist",
                                "Value": [],
                                "Type": "querystring"
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Name": "param4",
                                "Object": "query_name",
                                "Operator": "not_empty",
                                "Value": [],
                                "Type": "querystring"
                            }
                        },
                        {
                            "IsGroup": false,
                            "Condition": {
                                "Name": "header1",
                                "Object": "customize",
                                "Operator": "match",
                                "Value": [
                                    "header-value1;header-value2"
                                ],
                                "Type": "request_header"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

回源协议

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

表示回源请求使用的协议。该参数有以下取值:

  • http:表示回源请求使用 HTTP 协议。

  • https:表示回源请求使用 HTTPS 协议。

  • followclient:表示回源协议与用户请求使用的协议相同。

http

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginProtocol": "http"
}

源站证书校验

参数名称
数据类型
是否必选
参数说明
示例
OriginCertCheck
Object

表示 "源站证书校验" 特性的配置。要使用此特性,请 提交工单

该特性启用后,CDN 会校验源站证书的合法性,包括证书是否已被吊销、证书是否由可信 CA 签发、证书与源站域名是否匹配等。CDN 内置了常见可信 CA 的根证书。

该特性还支持双向认证,使源站对 CDN 身份进行校验。您需要在 CDN 中指定相应的客户端证书。

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginCertCheck": {
        "CertInfoList": [
            {
                "CertId": "cert_hosting-86594"
            }
        ],
        "ClientCertInfoList": [
            {
                "CertId": "cert_hosting-86040"
            }
        ],
        "Switch": true,
        "Type": "mutual"
    }
}

IPv6 回源

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

表示 "IPv6 回源" 的配置。该参数有以下取值:

  • ipv6_first:表示 CDN 始终尝试获取源站域名的 IPv6 地址。如果无法获取该 IP 地址,CDN 才尝试获取源站域名的 IPv4 地址。

  • ipv4_first:表示 CDN 始终尝试获取源站域名的 IPv4 地址。如果无法获取该 IP 地址,CDN 才尝试获取源站域名的 IPv6 地址。

  • followclient:表示 CDN 尝试获取与用户请求相同类型的 IP 地址。

该参数的默认值是 followclient

由于海外部分 CDN 回源节点不支持向 IPv6 地址发送回源请求,该功能仅适用于位于中国内地的回源节点。
followclient

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginIPv6": "ipv6_first"
}

回源 Host

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

如果源站服务器上有多个站点,该参数表示回源请求访问的站点域名。该参数对所有源站配置生效,但是优先级低于源站配置中 OriginHost 参数。

该参数的默认值与 Domain 相同。

如果源站是一个对象存储桶,您无需指定该参数。其默认值与源站配置中的 Address 相同。
img.example.com

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "OriginHost": "img.example.com"
}

加速区域

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

表示该加速域名的加速区域。该参数有以下取值:

  • chinese_mainland:表示中国内地。
  • global:表示全球。
  • outside_chinese_mainland:表示全球(不含中国内地)。
该参数的默认值是 chinese_mainland。要指定另两个值,请 提交工单
chinese_mainland

请求示例

POST https://cdn.volcengineapi.com/?Version=2021-03-01&Action=UpdateCdnConfig
{
    "Domain": "www.example.com",
    "ServiceRegion": "chinese_mainland"
}

返回参数

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022010415564801021219713102003D3F",
        "Action": "UpdateCdnConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    }
}

错误码

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

最近更新时间:2026.05.11 17:49:18
这个页面对您有帮助吗?
有用
有用
无用
无用