調用 API 服務後返回資料採用統一格式,具體包括:
狀態代碼
回應標頭
響應資料
成功結果
返回的 HTTP 狀態代碼為 2xx,代表調用成功;
響應資料格式為 JSON 格式,在每個 API 中有具體的描述響應資料的內容。
以下是建立叢集返回成功的樣本:
HTTP/1.1 201 Created
Date: Tue, 06 Nov 2018 06:12:41 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 35
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, OPTIONS
Access-Control-Allow-Headers: X-Requested-With, X-Sequence, _aop_secret, _aop_signature
Access-Control-Max-Age: 172800
x-acs-request-id: D874CC9A-C2D4-4DAE-A351-1699550F11A9
Server: AliyunBatchCompute
{"Id":"cls-6ki3sg6sqlno7nt8fu0007"}
錯誤結果
返回的 HTTP 狀態代碼為 4xx 或 5xx ,代表調用失敗,具體狀態代碼參考公用錯誤碼以及各個 API 的錯誤碼。
返回的 Body 中包含 “Code” 和 “Message” 欄位,您可以根據此資訊來排查錯誤。
回應標頭中的 x-acs-request-id 包含請求的 request id。
以下是一個請求錯誤的樣本:
HTTP/1.1 400 Bad Request
Date: Tue, 06 Nov 2018 08:30:40 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 90
Connection: close
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, OPTIONS
Access-Control-Allow-Headers: X-Requested-With, X-Sequence, _aop_secret, _aop_signature
Access-Control-Max-Age: 172800
x-acs-request-id: F067DAB7-57C4-4D08-BE49-CDB63BF5C6D2
Server: AliyunBatchCompute
{"Code":"InvalidParameter.ImageId","Message":"Specified parameter ImageId is not valid. "}