修改TOS回源鉴权配置
更新时间：2022-12-05 15:44:39
适用产品
网页加速、下载分发、全站加速、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案、点播分发、直播分发、移动加速
接口描述
通过接口自助实现TOS回源鉴权配置功能。接口url的*可为域名名称或域名id。
- 调用URL： https://open.chinanetcenter.com/api/config/tosaccess/*
- 调用方法：PUT
- 限制说明：·在中国 加速域名必须已备案完成。 · 加速域名必须不包含如下信息：出售药物和管制刀具类，含有不法言论、信息。 · 视频类加速域名必须有视听许可证；博客论坛或社区类加速域名必须有BBS专项审批资质。 · 接口请求和返回结果接受xml和json格式。
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Path 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
domain-name | String | 是 | 需要查询配置的域名或域名id |
Body 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
tos-access-authorization-rules | List | 是 | TOS回源鉴权配置，父标签
1.需要设置TOS回源鉴权时，此项必填
2.为 |
path-pattern | String | 是 | url匹配模式，支持正则，如果是全部匹配，入参可以配置为：.* |
except-path-pattern | String | 否 | 例外的url匹配模式，格式同path-pattern |
access-key | String | 是 | 校验所需的密钥 |
access-key-id | String | 是 | 校验所需的密钥ID |
header-name | String | 是 | 校验所需的头部名称，默认值为X-TOS-Authorization |
expire-time | String | 是 | 校验所需的超时时间窗口，单位秒（s），由于客户端和TOS可能存在时间偏差，两者差值的绝对值，超过这个时间窗口则视为过期。 |
data-id | Long | 否 | 配置多组配置时，具体某组配置的id。data-id可以通过查询接口获取。 注意： a、如果有传data-id，说明指定修改其中一组配置项内容，不需求修改其他组配置内容不需要入参； b、如果入参多组配置，其中有些组配置有传data-id，有些没有传，则有传data-id的表示修改具体某组配置，没有传data-id的表示在原来基础上新增一组配置； c、如果入参都没有传data-id,表示用本次的配置全量覆盖原先配置； d、如果入参没有传任何配置项参数，只传了域名和二级标签，表示清空这个接口对应域名二级服务所有配置； e、如果一组配置没有具体的配置项，则data-id必填，且值为实际存在的data-id，表示清空这个data-id对应配置项的值；不允许一组配置没有具体的配置项也没有data-id。 |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
code | String | 错误代码，当HTTPStatus不为202时出现，表示当前请求调用的错误类型 |
message | String | 响应信息，成功时为success |
示例
JSON
- 请求示例 复制成功
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://open.chinanetcenter.com/api/config/tosaccess/123344" \ -X "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type:application/json" \ -d ' { "tos-access-authorization-rules":[ { "data-id":"1", "path-pattern":".*", "except-path-pattern":"", "access-key":"yourAccessKey", "access-key-id":"yourAccessKeyID", "header-name":"X-TOS-Authorization", "expire-time":"900" } ] }'- 返回示例 复制成功
HTTP/1.1 202 Accepted Date: Sun, 05 May 2019 09:08:53 GMT Content-Type: application/json;charset=utf-8 x-cnc-request-id: 83bbebc7-2c95-47d7 {"message":"success"}
本篇文档内容对您是否有帮助？
有帮助
我要反馈