全部产品

调用方式

更新时间:2017-06-07 13:26:11   分享:   

请求结构

服务地址

HPC API的接入地址为:hpc.aliyuncs.com

通信协议

支持HTTP或者HTTPS通道(待确定)。

请求方法

支持HTTP GET方法,这种方法下请求参数包含在请求的URL中。

请求参数

每个请求都需要指定要执行的操作,即 Action 参数(例如 CreateInstance),以及公共请求参数和指定操作所特有的请求参数。

字符编码

请求及返回结果都使用 UTF-8 字符集进行编码。

公共参数

公共请求参数

公共请求参数是指每个接口都需要使用到的请求参数。

名称 类型 是否必须 描述
Format String 返回值的类型,支持 JSON 与 XML。默认为 XML。
Version String API 版本号,为日期形式:YYYY-MM-DD,本版本对应为 2014-05-26。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID。
Signature String 签名结果串,关于签名的计算方法,请参见<签名机制>。
SignatureMethod String 签名方式,目前支持 HMAC-SHA1。
Timestamp String 请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为YYYY-MM-DDThh:mm:ssZ,例如,2014-05-26T12:00:00Z(为北京时间 2014年5月26日20点0分0秒)。
SignatureVersion String 签名算法版本,目前版本是 1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值
ResourceOwnerAccount String 本次 API 请求访问到的资源拥有者账户,即登录用户名。此参数的使用方法,详见< 借助 RAM 实现子账号对主账号的 ECS 资源访问 >,(HPC 产品目前未支持RAM,请不要使用此参数)

公共返回参数

用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户。

返回结果

调用 API 服务后返回数据采用统一格式,返回的 HTTP 状态码为 2xx,代表调用成功;返回 4xx 或 5xx 的 HTTP 状态码代表调用失败。调用成功返回的数据格式主要有 XML 和 JSON 两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为 XML 格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

成功结果

XML示例:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--结果的根结点-->
  3. <接口名称+Response>
  4. <!--返回请求标签-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!--返回结果数据-->
  7. </接口名称+Response>

JSON示例:

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  3. /* 返回结果数据 */
  4. }

错误结果

调用接口出错后,将不会返回结果数据。调用方可根据返回的错误信息来定位错误原因。当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId。

签名机制

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

用户在访问时,按照下面的方法对请求进行签名处理:

  1. 使用请求参数构造规范化的请求字符串(Canonicalized Query String)
    (a) 参数排序。 按照参数名称的字典顺序对请求中所有的请求参数(包括“公共请求参数”和接口的自定义参数,但不能包括“公共请求参数”中提到的Signature 参数本身)进行排序。
    注:当使用 GET 方法提交请求时,这些参数就是请求 URI 中的参数部分(即 URI 中“?”之后由“&”连接的部分)。
    (b) 参数编码。 对排序之后的请求参数的名称和值分别用UTF-8字符集进行URL编码。编码的规则如下:

    1. i. 对于字符 A-Za-z0-9 以及字符“-”、“_”、“.”、“~”不编码;
    2. ii. 对于其他字符编码成 “%XY 的格式,其中 XY 是字符对应 ASCII 码的 16 进制表示。比如英文的双引号(”)对应的编码就是 %22 ;
    3. iii. 对于扩展的 UTF-8 字符,编码成 “%XY%ZA…” 的格式;
    4. iv. 需要说明的是英文空格( )要被编码是 %20,而不是加号(+)。

    注:该编码方式和一般采用的“application/x-www-form-urlencoded” MIME格式编码算法(比如Java标准库中的 java.net.URLEncoder的实现) 相似, 但又有所不同。 实现时, 可以先用标准库的方式进行编码, 然后把编码后的字符串中加号(+)替换成 %20、星号(*)替换成 %2A、%7E 替换回波浪号(~),即可得到上述规则描述的编码字符串。这个算法可以用下面的 percentEncode 方法来实现:

    1. private static final String ENCODING = "UTF-8";
    2. private static String percentEncode(String value) throws UnsupportedEncodingException {
    3. return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
    4. }


    (c) 将编码后的参数名称和值用英文等号(=)进行连接。
    (d) 将等号连接得到的参数组合按步骤(a)排好的顺序依次使用&符号连接,即得到规范化请求字符串。

  2. 将上一步构造的规范化字符串按照下面的规则构造成待签名的字符串:

    1. StringToSign=
    2. HTTPMethod + “&” +
    3. percentEncode(“/”) + ”&” +
    4. percentEncode(CanonicalizedQueryString)

    其中 HTTPMethod 是提交请求用的 HTTP 方法,比如 GET。
    percentEncode(“/”) 是按照 1.b 中描述的 URL 编码规则对字符 “/” 进行编码得到的值,即 “%2F”。
    percentEncode(CanonicalizedQueryString) 是对第 1 步中构造的规范化请求字符串按 1.b 中描述的 URL 编码规则编码后得到的字符串。

  3. 按照 RFC2104 的定义,计算待签名字符串 StringToSign 的 HMAC 值。注意:计算签名时使用的 Key 就是用户持有的 Access Key Secret 并加上一个 “&” 字符(ASCII:38),使用的哈希算法是 SHA1。

  4. 按照 Base64 编码规则把上面的 HMAC 值编码成字符串,即得到签名值(Signature)。

  5. 将得到的签名值作为 Signature 参数添加到请求参数中,即完成对请求签名的过程。
    注意:得到的签名值在作为最后的请求参数值提交给ECS服务器的时候,要和其他参数一样,按照 RFC3986 的规则进行 URL 编码。

本文导读目录
本文导读目录
以上内容是否对您有帮助?