PolarDB-X 1.0-API参考-1.0(2017版本)-OpenAPI使用-签名机制

简介: 关于 Access Key ID 与 Access Key SecretPolarDB-X 服务会对每个 API 的调用请求进行身份验证,所以无论使用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含由 Access Key ID 与 Access Key Secret 所产生的签名(Signature)信息。Access Key ID 和 Access Key Secret 由阿里云官方颁发给访问者(可以通过阿里云官方网站申请和管理),其中 Access Key ID 用于标识访问者的身份。Access Key Secret 是用于加密签名字符串和服务器端验证签名字符串

关于 Access Key ID 与 Access Key Secret

  • PolarDB-X 服务会对每个 API 的调用请求进行身份验证,所以无论使用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含由 Access Key ID 与 Access Key Secret 所产生的签名(Signature)信息。
  • Access Key ID 和 Access Key Secret 由阿里云官方颁发给访问者(可以通过阿里云官方网站申请和管理),其中 Access Key ID 用于标识访问者的身份。
  • Access Key Secret 是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密,只有阿里云和用户知道。

签名方法

发送 OpenAPI 请求时,请按照下面的方法对请求进行签名处理:

  1. 使用请求参数构造规范化的请求字符串(Canonicalized Query String)。1.1. 按照参数名称的字典顺序对请求中所有的请求参数(包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数,但不能包括“公共请求参数”中提到 Signature 参数本身)进行排序。注意:使用 GET 方法提交请求时,这些参数就是请求 URI 中的参数部分(即 URI 中“?”之后由“&”连接的部分)。1.2. 对每个请求参数的名称和值进行编码。名称和值要使用 UTF-8字符集进行 URL 编码,URL 编码的编码规则是:
  • 对于字符 A-Z、a-z、0-9以及字符“-”、“_”、“.”、“~”不编码;
  • 对于其他字符编码成“%XY”的格式,其中 XY 是字符对应 ASCII 码的16进制表示。比如英文的双引号(”)对应的编码就是%22;
  • 对于扩展的 UTF-8 字符,编码成“%XY%ZA…”的格式;
  • 英文空格( )要被编码是%20,而不是加号(+)。
    注意:一般支持 URL 编码的库(比如 Java 中的 java.net.URLEncoder)都是按照“application/x-www-form-urlencoded”的 MIME 类型的规则进行编码的。实现时可以直接使用这类方式进行编码,把编码后的字符串中加号(+)替换成%20、星号(*)替换成%2A、%7E 替换回波浪号(~),即可得到上述规则描述的编码字符串。
  1. 1.3. 对编码后的参数名称和值使用英文等号(=)进行连接。
    1.4. 把英文等号连接得到的字符串按参数名称的字典顺序依次使用&符号连接,即得到规范化请求字符串。
  2. 使用上一步构造的规范化字符串按照下面的规则构造用于计算签名的字符串。
  1. StringToSign=
  2. HTTPMethod+"&"+
  3. percentEncode("/")+"&"+
  4. percentEncode(CanonicalizedQueryString)
  • 其中 HTTPMethod 是提交请求用的 HTTP 方法,比 GET。
  • percentEncode(“/”)是按照1.2中描述的 URL 编码规则对字符“/”进行编码得到的值,即“%2F”。
  • percentEncode(CanonicalizedQueryString)是对第1步中构造的规范化请求字符串按 1.2 中描述的 URL 编码规则编码后得到的字符串。
  1. 按照 RFC2104 的定义,使用上面的用于签名的字符串计算签名 HMAC 值。
    注意:计算签名时使用的 Key 就是用户持有的 Access Key Secret 并加上一个“&”字符(ASCII:38),使用的哈希算法是 SHA1。
  2. 按照 Base64 编码规则把上面的 HMAC 值编码成字符串,即得到签名值(Signature)。
  3. 将得到的签名值作为 Signature 参数添加到请求参数中,即完成对请求签名的过程。
    注意:得到的签名值在作为最后的请求参数值提交给 PolarDB-X 服务器的时候,要和其他参数一样,按照 RFC3986 的规则进行 URL 编码)。

示例

以 DescribeDrdsInstances 为例,签名前的请求参数字符串为:


  1. AccessKeyId=testid&Action=DescribeDrdsInstances&Format=XML&RegionId=cn-hangzhou&SignatureMethod=HMAC-SHA1&SignatureNonce=ae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion=1.0&Timestamp=2016-01-20T14%3A26%3A15Z&Version=2015-04-13

对这个字符串进行编码,那么 StringToSign 就是:


  1. GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeDrdsInstances&Format%3DXML&RegionId%3Dcn-hangzhou&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3Dae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion%3D1.0&Timestamp%3D2016-01-20T14%253A26%253A15Z&Version%3D2015-04-13

假如使用的 Access Key ID 是“testid”,Access Key Secret 是“testsecret”,用于计算 HMAC 的 Key 就是“testsecret&”,则计算得到的签名值是:


  1. h/ka/jNO+WZv8Tqgo4a75sp6eTs=

签名后的请求 URL 为(注意增加了 Signature 参数):


  1. http://drds.aliyuncs.com/?AccessKeyId=testid&Action=DescribeDrdsInstances&Format=XML&RegionId=cn-hangzhou&SignatureMethod=HMAC-SHA1&SignatureNonce=ae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion=1.0&Timestamp=2016-01-20T14%3A26%3A15Z&Version=2015-04-13&Signature=h%2Fka%2FjNO%2BWZv8Tqgo4a75sp6eTs%3D

调用接口 DescribeDrdsInstances 的 Java 示例如下:


  1. publicstaticvoid drdsOpenAPI()throwsNoSuchAlgorithmException,InvalidKeyException,IOException{
  2.        //AK 与 SK
  3.        String accessKey ="testid";
  4.        String accessSecret ="testsecret";
  5.        //公共参数
  6.        Map<String,String> parameters =newTreeMap<String,String>();
  7.        parameters.put("Format","JSON");
  8.        parameters.put("Action","DescribeDrdsInstances");//调用 DescribeDrdsInstances 接口
  9.        parameters.put("Version","2015-04-13");
  10.        parameters.put("AccessKeyId", accessKey);
  11.        parameters.put("SignatureMethod","HMAC-SHA1");
  12.        parameters.put("Timestamp", getISO8601Time());
  13.        parameters.put("SignatureVersion","1.0");
  14.        parameters.put("SignatureNonce", UUID.randomUUID().toString());
  15.        parameters.put("RegionId","cn-hangzhou");
  16.        StringBuilder paramStr =newStringBuilder();
  17.        //拼接请求参数
  18.        for(Map.Entry<String,String> entry : parameters.entrySet()){
  19.          paramStr.append(percentEncode(entry.getKey())).append("=").append(percentEncode(entry.getValue())).append("&");
  20.        }
  21.        paramStr.deleteCharAt(paramStr.length()-1);

  22.        //计算签名
  23.        StringBuilder stringToSign =newStringBuilder();
  24.            stringToSign.append("GET").append("&").append(percentEncode("/"))
  25.                  .append("&").append(percentEncode(paramStr.toString()));
  26.            Mac mac =Mac.getInstance("HmacSHA1");
  27.        mac.init(newSecretKeySpec((accessSecret +"&").getBytes("UTF-8"),"HmacSHA1"));
  28.        byte[] signData = mac.doFinal(stringToSign.toString().getBytes("UTF-8"));
  29.        String signStr =Base64Helper.encode(signData);
  30.        //拼接 URL
  31.        String requestUrl ="http://drds.aliyuncs.com/?"+ paramStr.toString()+
  32.            "&Signature="+  percentEncode(signStr);
  33.        //准备发送 HTTP 请求
  34.        URL url =new URL(requestUrl);
  35.        HttpURLConnection httpConn =(HttpURLConnection)url.openConnection();
  36.        httpConn.setRequestMethod("GET");
  37.        httpConn.setDoOutput(true);
  38.        httpConn.setDoInput(true);
  39.        httpConn.setUseCaches(false);
  40.        httpConn.connect();
  41.        InputStream content = httpConn.getInputStream();
  42.        ByteArrayOutputStream outputStream =newByteArrayOutputStream();
  43.        byte[] buff =newbyte[1024];
  44.        while(true){
  45.           finalint read = content.read(buff);
  46.           if(read ==-1)break;
  47.           outputStream.write(buff,0,read);
  48.        }
  49.        System.out.println(newString(outputStream.toByteArray()));;
  50.  }

  51.  publicstaticString percentEncode(String value)throwsUnsupportedEncodingException{
  52.        return value !=null?URLEncoder.encode(value,"UTF-8").replace("+","%20")
  53.                .replace("*","%2A").replace("%7E","~"):null;
  54.    }

  55.  staticString getISO8601Time(){
  56.        SimpleDateFormat df =newSimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
  57.        df.setTimeZone(newSimpleTimeZone(0,"GMT"));
  58.        return df.format(newDate());
  59.  }
  60. }
相关文章
|
API 网络安全 网络架构
【Azure APIM】解答REST API实现"禁用自签名证书的证书链验证"中的backends参数值从那里取值的问题?
本文介绍APIM服务调用后端API时因自签名证书导致500错误的解决方案。通过REST API禁用证书链验证,关键在于获取正确的backendId(即APIM中配置的Backend名称),并调用PATCH接口设置validateCertificateChain为false,从而解决SSL/TLS信任问题。
385 7
|
数据采集 缓存 API
1688 API 实战指南:搞定批发场景的 3 大核心难题(附签名代码与避坑清单)
本文深入解析了1688 API 在批发场景下的三大核心难题及解决方案,涵盖签名机制、商品数据处理与订单同步等高频问题,提供可复用代码与避坑清单,助你高效对接1688平台。
|
存储 机器学习/深度学习 API
Android API Level 到底是什么?和安卓什么关系?应用发布如何知道自己的版本?优雅草卓伊凡
Android API Level 到底是什么?和安卓什么关系?应用发布如何知道自己的版本?优雅草卓伊凡
2087 31
Android API Level 到底是什么?和安卓什么关系?应用发布如何知道自己的版本?优雅草卓伊凡
|
存储 监控 前端开发
淘宝商品详情 API 实战:5 大策略提升店铺转化率(附签名优化代码 + 避坑指南)
本文深入解析淘宝商品详情API的核心字段与实战应用,分享如何通过动态定价、库存预警、差评控制等5大策略提升电商转化率。结合300+店铺实战经验,提供优化代码与避坑指南,助力开发者与运营者实现数据驱动的精细化运营。
|
缓存 算法 API
从 0 实现 API 接口签名验证系统:基于 HMAC-SHA256 的防篡改方案(附 Python 全代码)
本文介绍基于 的 API 接口签名验证系统,实现防篡改与防重放攻击,包含完整设计原理、签名生成规则及可运行的 Python 客户端与服务端代码,并提供安全性优化与部署建议。
|
存储 安全 NoSQL
【干货满满】API安全加固指南:签名防篡改+Access Token管理最佳实践
API 安全关乎业务与用户隐私,签名机制防篡改、伪造请求,Access Token 管理身份与权限。本文详解签名生成、Token 类型与管理、常见安全问题及最佳实践,助开发者构建安全可靠的 API 体系。
|
安全 API 开发者
鸿蒙NEXT-鸿蒙老版本迁移最新版本(API19,modelVersion5.1.1)
鸿蒙更新至API19,新增热更新支持、资源过滤、内存分析等功能。本文详解手动迁移步骤及上下文获取问题解决方案。
644 0
|
Java API PHP
【亲测有效,官方提供】php版本企查查api接口请求示例代码,php请求企查查api接口,thinkphp请求企查查api接口
【亲测有效,官方提供】php版本企查查api接口请求示例代码,php请求企查查api接口,thinkphp请求企查查api接口
1105 1
|
文字识别 算法 API
视觉智能开放平台产品使用合集之海外是否可以访问人物动漫化的api版本
视觉智能开放平台是指提供一系列基于视觉识别技术的API和服务的平台,这些服务通常包括图像识别、人脸识别、物体检测、文字识别、场景理解等。企业或开发者可以通过调用这些API,快速将视觉智能功能集成到自己的应用或服务中,而无需从零开始研发相关算法和技术。以下是一些常见的视觉智能开放平台产品及其应用场景的概览。
454 0
|
Oracle Java 关系型数据库
JDK版本特性问题之在 JDK 11 中,HTTP Client API 的特点有哪些
JDK版本特性问题之在 JDK 11 中,HTTP Client API 的特点有哪些

热门文章

最新文章

相关产品

  • 云原生分布式数据库 PolarDB-X