共通パラメーター

共通リクエストパラメーター

共通リクエストパラメーターとは、各 API で必須のリクエストパラメーターのことです。

パラメーター

名前 データ型 必須/省略可能 説明
Format String 省略可能 リターン値の形式。 有効な値 : JSON と XML。 デフォルト値 : XML。
Version String 必須 API のバージョン。 書式 : YYYY-MM-DD 現在のバージョンは 2016-04-08 です。
AccessKeyId String 必須 Alibaba Cloud がサービスへのアクセス用に提供するキー ID
Signature String 必須 署名の結果文字列。 署名の計算方法の詳細は、 「署名 (Sign signatures)」をご参照ください。
SignatureMethod String 必須 署名のモードです。 現在サポートされているのは HMAC-SHA1 です。
Timestamp String 必須 リクエストするタイムスタンプです。 日付の書式は ISO 8601 標準に従い、UTC 時間を使用します。 書式 : YYYY-MM-DDThh:mm:ssZ。 たとえば、2013-08-15T12:00:00Z は、北京時間 2013 年 8 月 15 日 20:00:00 を示します。
SignatureVersion String 必須 署名のアルゴリズムバージョン。 現在のバージョンは 1.0 です。
SignatureNonce String 必須 ネットワークリプレイ攻撃防止にする一意の乱数です。 リクエストごとに異なる乱数を使用する必要があります。

コーディング例

https://emr.aliyuncs.com/
? Format=json
&Version=2016-04-08
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z

共通レスポンスパラメーター

API を呼び出すたびに、リクエストが成功したかどうかにかかわらず、システムは一意の識別コード (RequestId) を返します。

  • コーディング例
    • 成功したレスポンスのコーディング例
      XML 形式で返された結果には、リクエストが成功したかどうかを示すメッセージと、特定のシナリオ情報が含まれます。 コーディング例 
      {
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  /* Returned results
*/
}
    • レスポンスがエラーになる場合のコーディング例
      API 呼び出しが失敗すると結果は返されません。 エラーコードに従ってエラーの原因を見つけることができます。 HTTP リクエストが失敗すると、4xx または 5xx の形式のステータスコードが返されます。 レスポンスには、特定のエラーコードとエラー情報が含まれています。 メッセージ本文には、グローバルに一意な RequestId と、アクセス先としてリクエストするサイトの HostId も含まれます。 エラーの原因を見つけられない場合は、チケットを起票してサポートセンターに問い合わせ、HostId と RequestId をご提供ください。 
      {
  "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
  "HostId": "emr.aliyuncs.com",
  "Code": "UnsupportedOperation",
  "Message": "The specified action is not supported."
}
  • 一般的なエラーコード

    詳細は、「ECS の一般的なエラーコード (ECS common error codes)」をご参照ください。