1. 公共参数
请求参数是用于标识用户和接口签名的参数。
💡
如非必要,在每个接口单独的文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
请求参数的具体内容会因您使用的签名方法版本不同而有所差异。
1.1. 使用签名方法的公共参数
使用签名方法时,公共参数需要统一放到 Http Header 中。如下表所示:
参数名称 | 类型 | 必选 | 请求头 | 描述 |
---|---|---|---|---|
Version | String | 是 | X-AIC-Version | 操作的接口版本。当前只支持的版本为 V3 |
Action | String | 是 | X-AIC-Action | 操作名称。取值请参考各个接口文档中的操作类型值。例如获取云服务器实例列表接口,取值为 DescribeInstances。 |
Timestamp | Integer | 是 | X-AIC-Timestamp | 当前 10 位 UNIX 时间戳,可记录发起 API 请求的时间。例如 1529223702,如果与当前时间相差过大,会引起签名过期错误。 |
AccessKey | String | 是 | X-AIC-AccessKey | 本次请求的用户唯一标识 |
SignedHeaders | String | 是 | X-AIC-SignedHeaders | 本次参与签名的 Header |
Signature | String | 是 | X-AIC-Signature | 本次请求签名的最终结果 |
Service | String | 是 | X-AIC-Service | 本次请求签名的服务类型 |
Host | String | 是 | Host | HTTP 客户端默认都会携带该 Header 信息,不用做特殊设置。 |
Content-Type | String | 是 | Content-Type | 接口支持的数据格式。当前智算云只支持 Content-Type:application/json |
💡
注意:
当前智算云平台支持的消息加密算法是 HmacSHA256
1.1.1. Version 说明
Version 表示您要访问的接口的版本。
当前支持的版本内容为 V3
1.1.2. Action 说明
Action 表示您要调用的接口操作。
以云服务器实例为例,查询云服务器实例列表的操作名称为 DescribeInstances,同样这个也是接口的名称
1.1.3. Timestamp 说明
Timestamp 表示当前访问接口时的时间。这里要提供 10 位精确到秒的 UNIX 时间戳值。
1.1.4. AccessKey 说明
AccessKey 是您从智算云运营系统或云桌面获取到的 AccessKey 值。
1.1.5. SignedHeaders 说明
SignedHeaders 表示本次请求参与到签名的 Header 内容。
默认情况下必须要参与的 Header 有:
- Host。 该值默认为 ai.blsc.cn
- Content-Type。该值默认为 application/json
SignedHeaders 只保存 Head 的 Key 值,比如 content-type;host。具体格式说明请参照签名方法页面。
如果为了安全考虑可以根据您实际的要求把需要的 Header 加入到签名参数中。
1.1.6. Signature 说明
Signature 就是您最终为待访问的接口签名结果。
详见签名方法页面中的说明
1.1.7. Service 说明
Service 是指定您要访问的目标接口所属于的服务类型。
智算云平台目前支持的服务类型有
- 地域服务 region
- 产品规格服务 product
- 云服务器服务 ecs
- 云盘服务 ebs
- 公网 IP 服务 eip