CDN加速

文档中心 API文档 修改Amazon S3鉴权配置

修改Amazon S3鉴权配置

更新时间:2020-11-16 17:10:41

适用产品

应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案、点播分发、直播分发、移动加速、网页加速、下载分发、全站加速

接口描述

通过接口自助实现Amazon S3鉴权配置功能。接口url的*可为域名名称或域名id。

  • 调用URL: https://open.chinanetcenter.com/api/config/amazons3access/*
  • 调用方法:PUT
  • 限制说明:·在中国 加速域名必须已备案完成。 · 加速域名必须不包含如下信息:出售药物和管制刀具类,含有不法言论、信息。 · 视频类加速域名必须有视听许可证;博客论坛或社区类加速域名必须有BBS专项审批资质。 · 接口请求和返回结果接受xml和json格式。

请求参数

Body 参数

XML
参数名称类型必填描述
amazon-s3-access-authorization-rules
ComplexAmazon S3鉴权配置,父标签 1.需要设置Amazon S3鉴权时,此项必填 2.为时清空Amazon S3鉴权配置的配置 3.点播下载支持,网页wsa不支持 4.Amason S3和Aliyun OSS不可同时配置
amazon-s3-access-authorization-rule
ComplexAmazon S3鉴权配置,父标签,可配置多条规则
path-pattern
Stringurl匹配模式,支持正则,如果是全部匹配,入参可以配置为:.*
except-path-pattern
String例外的url匹配模式,格式同path-pattern
add-authorization-header
Boolean是否添加鉴权头部,为true,则回源按照Amazon S3的算法添加 添加Authorization头部。 允许值为true和false,默认为false。
access-key
String校验所需的密钥
access-key-id
String校验所需的密钥ID
signature-version
Int算法版本,默认值2,目前仅支持2和4
region
String认证地区,见AWS官网区域说明
data-id
Int配置多组配置时,具体某组配置的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 参数

XML&JSON
参数名称类型描述
http status code
inthttpstatus=202;   表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-id
String唯一标示的id,用于查询每次请求的任务 (适用全部接口)
code
String错误代码,当HTTPStatus不为202时出现,表示当前请求调用的错误类型
message
String响应信息,成功时为success

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidParameterNo amazon-s3-access-authorization-rules was specified.400amazon-s3-access-authorization-rules字段不存在
InvalidParameterThe request has null config with null data-id, please remove it.400amazon-s3-access-authorization-rule为空
InvalidParameterThe specified path-pattern could not be blank.400path-pattern为空或字段不存在
InvalidParameterThe specified add-authorization-header could not be blank.400add-authorization-header为空或字段不存在
InvalidParameterThe specified add-authorization-header is invalid.400add-authorization-header值不合法
InvalidParameterThe specified access-key could not be blank.400access-key为空或字段不存在
InvalidParameterThe specified access-key-id could not be blank.400access-key-id为空或字段不存在
InvalidParameterThe specified signature-version could not be blank.400signature-version为空
InvalidParameterThe specified signature-version is invalid.400signature-version值不合法
NoSuchDomainThe specified domain does not exist.404域名不存在
CustomerNoOwnDomaincustomer not own domain name[{0}]400域名不属于当前客户

示例

JSON
XML
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/amazons3access/123344" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '
{
    "amazon-s3-access-authorization-rules":[
        {
          "data-id":"1",
          "add-authorization-header":"true",
          "path-pattern":".*",
          "except-path-pattern":"",
          "access-key":"yourAccessKey",
          "access-key-id":"yourAccessKeyID",
          "signature-version":"4",
          "region":"us-east-1"
        }
    ]
}'
返回示例
复制代码 复制成功
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"}
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!