文档简介:
IAM API请求结构
-
接入地址
IAM服务的接入地址为:oos-cn-iam.ctyunapi.cn。
-
通信协议
为了保证通信的安全性,IAM仅支持HTTPS
-
请求方法
IAM支持POST请求方法发送请求。
-
请求参数
每个请求都需要指定如下信息:
-
要执行的操作:Action参数。
-
每个操作接口都需要包含的公共请求参数。
-
操作接口所特有的请求参数。
注意:请求的参数都需要url encode,服务端进行url decode。
-
字符编码
请求及返回结果都使用UTF-8字符集进行编码。
公共参数
本节主要描述公共请求参数和请求结果。
说明:在后续提到具体IAM API时,举例中都会有公共请求头、公共响应头、公共响应结果参数,但是不对其进行描述和解释。
-
公共请求头
在每个请求中,都需要携带公共参数和对应的接口参数。公共请求参数如表所示:
名称 |
描述 |
是否必填 |
Host |
IAM访问域名,IAM的访问域名是oos-cn-iam.ctyunapi.cn。 |
是 |
Authorization |
请求头签名。 支持V4签名认证。 类型:字符串。 |
是 |
X-Amz-Date |
日期和时间格式必须遵循ISO 8601标准,并且必须使用“yyyyMMddTHHmmssZ”格式进行格式化。例如,如果日期和时间是“08/01/2018 15:32:41.982-700”,则必须首先将其转换为UTC(协调世界时),然后提交为“20180801T083241Z”。 |
是 |
Content-Type |
请求内容类型。 类型:字符串。 取值:application/x-www-form-urlencoded; charset=utf-8 |
是 |
-
公共响应头
每个IAM API响应结果中都会包含公共响应头。
名称 |
描述 |
HTTP/1.1 XXX |
状态码。
|
x-amz-request-id |
服务端生成的用于标识请求的ID。 |
Content-Type |
响应内容类型。 |
Date |
响应日期。 |
Server |
服务器名。 |
Content-Length |
响应体的长度,单位为Byte。 |
-
公共返回参数
每个IAM API响应结果中,除了包含公共响应头、每个IAM API相应的响应参数(见具体API的响应结果),还包含公共返回参数。下表为公共的响应参数描述。
名称 |
描述 |
RequestId |
请求ID。 |
响应结果
调用IAM API后返回数据采用统一格式,响应结果格式为XML格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。
-
成功响应结果
调用IAM API成功后,如果响应结果HTTP状态为:200 OK,代表IAM API调用成功。示例如下:
HTTP/1.1 200 OK <公共响应头>
<API具体响应结果> <公共响应参数> |
-
失败响应结果
调用IAMAPI失败后,如果响应结果HTTP状态为:4xx或者5xx,代表调用失败。示例如下:
HTTP/1.1 4xx或者5xx <公共响应头>
<API具体响应结果> <公共响应参数> |