接入地址
對象存儲網絡接入地址為:oos-cn-iam.ctyunapi.cn,對象存儲網絡2接入地址為:oos-cn2-iam.ctyunapi.cn,香港精品網和香港普通網的接入地址為oos-cnhk-iam.ctyunapi.cn。
通信協議
為了保證通信的安全性,IAM僅支持HTTPS。
請求方法
IAM支持POST請求方法發送請求。
請求參數
每個請求都需要指定如下信息:
- 要執行的操作:Action參數。
- 每個操作接口都需要包含的公共請求參數。
- 操作接口所特有的請求參數。
注意請求的參數都需要url encode,服務端進行url decode。
公共參數
說明在后續提到具體IAM API時,舉例中都會有公共請求頭,但是不對其進行描述和解釋。
在每個請求中,都需要攜帶公共參數和對應的接口參數。公共請求參數如表所示:
名稱 描述 是否必須 Host IAM訪問域名:
對象存儲網絡:oos-cn-iam.ctyunapi.cn。
對象存儲網絡2:oos-cn2-iam.ctyunapi.cn。
香港精品網和香港普通網:oos-cnhk-iam.ctyunapi.cn。
是 Authorization 請求頭簽名。
支持V4簽名認證。
類型:字符串
是 X-Amz-Date 日期和時間格式必須遵循ISO 8601標準,并且必須使用“yyyyMMddTHHmmssZ”格式進行格式化。例如,如果日期和時間是“08/01/2018 15:32:41.982-700”,則必須首先將其轉換為UTC(協調世界時),然后提交為“20180801T083241Z”。 是 Content-Type 請求內容類型。
類型:字符串
取值:application/octet-stream。
是 Connection 客戶端與OOS服務器之間的連接狀態。
取值:
keep-alive:長連接,請求結束后繼續保持連接。
close:短連接,請求結束后關閉連接。
默認值為:keep-alive。
否
響應結果
說明調用IAM API后返回數據采用統一格式,響應結果格式為XML格式。本文檔中的響應示例為了便于用戶查看,做了格式化處理,實際返回結果是沒有進行換行、縮進等處理的。
公共響應頭
說明在后續提到具體IAM API時,舉例中都會有公共響應頭,但是不對其進行描述和解釋。
每個IAM API響應結果中都會包含公共響應頭。公共響應頭如下:
名稱 描述 x-amz-request-id 服務端生成的用于標識請求的ID。 Content-Type 響應內容類型。 Date 響應日期。 Server 服務器名。 Content-Length 響應體的長度,單位為Byte。 Connection 客戶端與OOS服務器之間的連接狀態。
如果請求時Connection值為keep-alive,請求結束后繼續保持連接,不返回此響應頭。
如果請求時Connection值為close,請求結束后關閉連接,返回此響應頭Connection: close。
成功響應結果
調用IAM API成功后,如果響應結果HTTP狀態為:200 OK,代表IAM API調用成功。示例如下:
HTTP/1.1 200 OK
<公共響應頭>
?
<公共響應參數>
具體響應結果>
失敗響應結果
調用IAM API失敗后,如果響應結果HTTP狀態為:4xx或者5xx,代表調用失敗。示例如下:
HTTP/1.1 4xx或者5xx
<公共響應頭>
?
<公共響應參數>
具體響應結果>
字符編碼
請求及返回結果都使用UTF-8字符集進行編碼。