本文介绍调用内容检测API时构造调用请求的方法,适用于基于API URL发起HTTP/HTTPS请求的用户。

说明 我们提供多种编程语言的SDK及第三方SDK,可以免去您自己构造API请求的烦恼。更多信息,请参考SDK章节

通信协议

支持HTTP/HTTPS协议。

请求方法

所有接口都支持POST/GET方法。

字符编码

所有接口的请求参数和返回结果编码方式都是UTF-8。

API请求结构

类型 描述 备注
API接入地址 具体API接口地址。 示例:http(https)://green.cn-shanghai.aliyuncs.com
公共参数 每个接口都包含有的通用参数。 详见公共参数说明
接口自定义参数 每个接口特有的参数。 详见每个API接口定义。

API接入地址

内容检测API配置管理服务(自定义关键词库、相似文本库、图库和OSS检测内容管理)的接入地址为:
http(s)://green.cn-shanghai.aliyuncs.com
注意 只支持以上地址。国内所有地域都请使用以上地址来调用服务,我们会自动同步到每个地域。

公共参数

名称 类型 是否必需 描述
Action String 要执行的操作,即API接口名称。具体取值参阅 API概览
AccessKeyId String 访问密钥 ID。AccessKey用于调用 API。
Signature String 您的签名。取值参阅签名机制
SignatureMethod String 签名方式。取值:HMAC-SHA1
SignatureVersion String 签名算法版本。取值:1.0
SignatureNonce String 签名唯一随机数。用于防止网络重放攻击,建议您每一次请求都使用不同的随机数。
Timestamp String 请求的时间戳。按照ISO8601标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。示例:2018-01-01T12:00:00Z,表示北京时间2018年01月01日20点00分00秒。
Version String API的版本号,格式为YYYY-MM-DD。取值:2017-08-23
Format String 返回参数的语言类型。取值范围:
  • json
  • xml(默认))

接口自定义参数

请在API 概览中,单击每个API进行查阅。

签名机制

对于每一次HTTP或者HTTPS协议请求,我们会根据访问中的签名信息验证访问请求者身份。具体由使用AccessKeyID和AccessKeySecret对称加密验证实现。

AccessKey相当于用户密码,AccessKey用于调用API,而用户密码用于登录阿里云控制台 。其中AccessKeyID是访问者身份,AccessKeySecret是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。

  1. 构造规范化请求字符串。
    1. 排序参数。排序规则以首字母顺序排序,排序参数包括公共参数和接口自定义参数,不包括公共请求参数中的Signature参数。
      说明 当使用GET方法提交请求时,这些参数就是请求URL中的参数部分,即URL中 ?之后由 &连接的部分。
    2. 编码参数。使用UTF-8字符集按照RFC3986规则编码请求参数和参数取值,编码规则如下:
      • 字符A~Z、a~z、0~9以及字符-_.~不编码。
      • 其它字符编码成%XY的格式;其中XY是字符对应ASCII码的16进制。示例:半角双引号(")对应 %22
      • 扩展的UTF-8字符,编码成%XY%ZA…的格式。
      • 空格( )编码成%20,而不是加号(+)。
        该编码方式与 application/x-www-form-urlencodedMIME格式编码算法相似,但又有所不同。 如果您使用的是Java标准库中的 java.net.URLEncoder,可以先用标准库中 percentEncode编码,随后将编码后的字符中加号( +)替换为 %20、星号( *)替换为 %2A%7E 替换为波浪号( ~),即可得到上述规则描述的编码字符串。
        private static final String ENCODING = "UTF-8";
        private static String percentEncode(String value) throws UnsupportedEncodingException {
        return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
        }
    3. 使用等号(=)连接编码后的请求参数和参数取值。
    4. 使用与号(&)连接编码后的请求参数,注意参数排序与步骤1 一致。

    现在,您得到了规范化请求字符串(CanonicalizedQueryString),其结构遵循API请求结构。

  2. 构造签名字符串。
    1. 构造待签名字符串StringToSign。您可以同样使用percentEncode处理上一步构造的规范化请求字符串,规则如下:
      StringToSign=
        HTTPMethod + "&" + //HTTPMethod:发送请求的 HTTP 方法,例如 GET。
        percentEncode("/") + "&" + //percentEncode("/"):字符(/)UTF-8 编码得到的值,即 %2F。
        percentEncode(CanonicalizedQueryString) //您的规范化请求字符串。
    2. 按照RFC2104 的定义,计算待签名字符串StringToSign的HMAC-SHA1值。示例使用的是Java Base64编码方法。
      Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
      说明 计算签名时,RFC2104规定的Key值是您的 AccessKeySecret并加上与号( &),其ASCII值为38。
    3. 添加根据RFC3986规则编码后的参数Signature到规范化请求字符串URL中。

代码示例

示例一:参数拼接法

以调用 DescribeKeywordLib查询词库为例。假设您获得了 AccessKeyID=testid以及 AccessKeySecret=testsecret,签名流程如下所示:
  1. 构造规范化请求字符串。
    http://ecs.aliyuncs.com/?Timestamp=2016-02-23T12:46:24Z&Format=XML&AccessKeyId=testid&Action=DescribeKeywordLib&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&SignatureVersion=1.0
  2. 构造待签名字符串StringToSign。
    GET&%2F&AccessKeyId%3Dtestid%26Action%3DDescribeKeywordLib%26Format%3DXML%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf%26SignatureVersion%3D1.0%26Timestamp%3D2016-02-23T12%253A46%253A24Z%26Version%3D2014-05-26
  3. 计算签名值。因为AccessKeySecret=testsecret,用于计算的Key为 testsecret&,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ+uX5qY=。示例使用的是Java Base64编码方法。
    Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
  4. 添加RFC3986规则编码后的Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D步骤1的URL中。
    http://ecs.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeKeywordLib&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%253A46%253A24Z
通过以上URL,您可以使用浏览器、curl或者wget等工具发起HTTP请求调用DescribeKeywordLib,查看自定义关键词库列表。

示例二:编程语言法

依然以调用 DescribeKeywordLib查询词库为例。假设您获得了 AccessKeyID=testid以及 AccessKeySecret=testsecret,并且假定所有请求参数放在一个Java Map<String, String>对象里。
  1. 预定义编码方法。
    private static final String ENCODING = "UTF-8";
    private static String percentEncode(String value) throws UnsupportedEncodingException {
      return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
    }
  2. 预定义编码时间格式Timestamp。参数Timestamp必须符合ISO8601规范,并需要使用UTC时间,时区为+0。
    private static final String ISO8601_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
    private static String formatIso8601Date(Date date) {
      SimpleDateFormat df = new SimpleDateFormat(ISO8601_DATE_FORMAT);
      df.setTimeZone(new SimpleTimeZone(0, "GMT"));
      return df.format(date);
    }
  3. 构造请求字符串。
    final String HTTP_METHOD = "GET";
    Map parameters = new HashMap();
    // 输入请求参数
    parameters.put("Action", "DescribeKeywordLib");
    parameters.put("Version", "2017-08-23");
    parameters.put("AccessKeyId", "testid");
    parameters.put("Timestamp", formatIso8601Date(new Date()));
    parameters.put("SignatureMethod", "HMAC-SHA1");
    parameters.put("SignatureVersion", "1.0");
    parameters.put("SignatureNonce", UUID.randomUUID().toString());
    parameters.put("Format", "XML");
    // 排序请求参数
    String[] sortedKeys = parameters.keySet().toArray(new String[]{});
    Arrays.sort(sortedKeys);
    final String SEPARATOR = "&";
    // 构造 stringToSign 字符串
    StringBuilder stringToSign = new StringBuilder();
    stringToSign.append(HTTP_METHOD).append(SEPARATOR);
    stringToSign.append(percentEncode("/")).append(SEPARATOR);
    StringBuilder canonicalizedQueryString = new StringBuilder();
    for(String key : sortedKeys) {
    // 这里注意编码 key 和 value
      canonicalizedQueryString.append("&")
      .append(percentEncode(key)).append("=")
      .append(percentEncode(parameters.get(key)));
    }
    // 这里注意编码 canonicalizedQueryString
    stringToSign.append(percentEncode(
      canonicalizedQueryString.toString().substring(1)));
  4. 签名。因为 AccessKeySecret=testsecret,所以用于计算HMAC的Key为testsecret&,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D
    // 以下是一段计算签名的示例代码
    final String ALGORITHM = "HmacSHA1";
    final String ENCODING = "UTF-8";
    key = "testsecret&";
    Mac mac = Mac.getInstance(ALGORITHM);
    mac.init(new SecretKeySpec(key.getBytes(ENCODING), ALGORITHM));
    byte[] signData = mac.doFinal(stringToSign.getBytes(ENCODING));
    String signature = new String(Base64.encodeBase64(signData));
    增加签名参数后,按照RFC3986规则编码后的URL如下所示:
    http://ecs.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeKeywordLib&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%253A46%253A24Z
  5. 使用浏览器、curl或者wget等工具发送HTTP请求,获取返回结果。

API返回结果

请在API概览中,单击每个API进行查阅。