您可以通过发送HTTP GET请求调用云安全中心API,并按照接口说明在请求中加入相应的请求参数。调用接口后系统会返回处理结果。请求和返回结果都使用UTF-8字符集进行编码。

请求结构

云安全中心的API是RPC风格,您可以通过发送HTTP GET请求调用云安全中心API。

其请求结构如下:

https://Endpoint/?Action=xx&Parameters
其中:
  • Endpoint:云安全中心API的服务接入地址为tds.aliyuncs.com。
  • Action:要执行的操作,如使用DescribeAlarmEventList查询安全事件列表。
  • Version:要使用的API版本,云安全中心的API版本是2018-12-03
  • Parameters:请求参数,每个参数之间用“&”分隔。

    请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详细内容参见公共参数

下面是一个调用DescribeAlarmEventList接口查询安全事件列表的示例:
说明 为了便于用户查看,本文档中的示例都做了格式化处理。
http(s)://tds.aliyuncs.com/?Action=DescribeAlarmEventList
&Format=xml
&Version=2018-12-03
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2012-06-01T12:00:00Z
...

API授权

为了确保您的账号安全,建议您使用子账号的身份凭证调用API。如果您使用RAM账号调用云安全中心API,您需要为该RAM账号创建、附加相应的授权策略。

API签名

云安全中心服务会对每个API请求进行身份验证,无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名(Signature)信息。

RPC API要按以下格式在API请求的Query中增加签名(Signature)。

https://Endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOju****&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
其中:
  • SignatureMethod:签名方式,目前支持HMAC-SHA1。
  • SignatureVersion:签名算法版本,目前版本是 1.0。
  • SignatureNonce:唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值,建议使用通用唯一识别码(Universally Unique Identifier, UUID)。
  • Signature:使用AccessKey Secret对请求进行对称加密后生成的签名。

云安全中心通过使用AccessKey ID和AccessKey Secret进行对称加密的方法来验证请求的发送者身份。AccessKey是为阿里云账号和RAM用户发布的一种身份凭证(类似于用户的登录密码),其中AccessKey ID用于标识访问者的身份,AccessKey Secret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。

DescribeAlarmEventList为例,假设AccessKey ID是testid, AccessKey Secret是testsecret,则签名前的请求URL如下:
https://tds.aliyuncs.com/?Action=DescribeAlarmEventList
&TimeStamp=2016-02-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
&Version=2018-01-17
&SignatureVersion=1.0
完成以下步骤计算签名:
  1. 使用请求参数创建待签名字符串:
    GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeAlarmEventList&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2018-12-03
    1. 按照参数名称的字典顺序对请求中所有的请求参数(包括公共请求参数和接口的自定义参数,但不包括公共请求参数中的Signature参数)进行排序。

      当使用GET方法提交请求时,这些参数就是请求URI中的参数部分,即URI中问号(?)之后由and(&)连接的部分。

    2. 对排序之后的请求参数的名称和值分别用UTF-8字符集进行URL编码。编码规则如下:
      字符 编码方式
      A-Z、a-z和0-9以及连接号(-)、下划线(_)、英文句点(.)和波浪线(~) 不编码。
      其它字符 编码成 %XY 的格式,其中 XY 是字符对应ASCII码的16进制表示。例如英文的双引号(””)对应的编码为 %22
      扩展的UTF-8字符 编码成 %XY%ZA…的格式。
      英文空格 编码成 %20,而不是加号(+)。

      该编码方式和一般采用的 application/x-www-form-urlencoded MIME格式编码算法(例如Java标准库中的 java.net.URLEncoder的实现)存在区别。

      编码时可以先用标准库的方式进行编码,然后把编码后的字符串中的加号(+)替换成 %20,星号(*)替换成 %2A%7E替换回波浪线(~),即可得到上述规则描述的编码字符串。本算法可以用下面的percentEncode方法来实现:

      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. 将等号连接得到的参数组合按步骤一排好的顺序依次使用and(&)符号连接,即得到规范化请求字符串。
  2. 计算待签名的HMAC的值。
    在AccessKey Secret后添加一个“&”作为计算HMAC值的key。本示例中的key为testsecret&
    CT9X0VtwR86fNWSnsc6v8YGOjuE=
  3. 将签名加到请求参数中:
    https://tds.aliyuncs.com/?Action=DescribeAlarmEventList
    &TimeStamp=2016-02-23T12:46:24Z
    &Format=XML
    &AccessKeyId=testid
    &SignatureMethod=HMAC-SHA1
    &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
    &Version=2018-12-03
    &SignatureVersion=1.0
    &Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D
说明 阿里云提供了多种语言的SDK及第三方SDK,可以免去您对签名算法进行编码的麻烦。更多阿里云SDK信息请参见阿里云开发工具包(SDK)