このトピックでは、すべての Alibaba Cloud Global Accelerator の API 操作に必要なリクエストパラメーターとレスポンスパラメーターについて説明します。

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

表 1. 共通リクエストパラメーター
パラメーター データ型 必須/任意 説明
形式 String 任意 リターン値の形式。 有効な値 : JSON と XML。 既定値:JSON
Version String 必須 YYYY-MM-DD 日付形式を使用した API バージョンです。 値を 2019-11-20 に設定します。
AccessKeyId String 必須 Alibaba Cloud から提供された AccessKey ID を設定します。
Signature String 必須 現在のリクエストの署名文字列。
SignatureMethod String 必須 リクエスト署名の計算に使用されるアルゴリズム。 値を HMAC-SHA1 に設定します。
Timestamp String 必須 リクエストのタイムスタンプを設定します。 時刻を ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ) の形式で指定します。 時間は UTC とする必要があります。

例:2013-01-10T12:00:00Z の場合、2013 年 1 月 19 日の 20:00:00 (UTC + 8) を表します。

SignatureVersion String 必須 署名暗号化アルゴリズムのバージョンを設定します。 値を 1.0 に設定します。
SignatureNonce String 必須 反射攻撃を防ぐための、一意の乱数を設定します。

各リクエストで異なる乱数を使用する必要があります。

ResourceOwnerAccount String 任意 この API 要求を使用してアクセスするリソースの所有者アカウント (ログインユーザー名)。
リクエスト例
http://ga.aliyuncs.com/?Action=DescribeListener
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2014-11-11
&SignatureVersion=1.0
&Signature=Signature

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

API のレスポンスは HTTP レスポンス形式です。 レスポンスデータは JSON 形式または XML 形式のいずれかで返されます。 リクエストでレスポンスの形式を指定できます。 デフォルトのレスポンス形式は XML です。 呼び出しの成否に関わらず、すべてのレスポンスで一意の RequestId が返されます。
  • HTTP ステータスコードが 2xx の場合、呼び出しが成功したことを示します。
  • HTTPステータスコードが 4xx または 5xx の場合、呼び出しが失敗したことを示します。
レスポンス例:
  • XML 形式
    <? xml version="1.0" encoding="utf-8"? > 
        <!—Result root node-->
        <Operation name+Response>
            <!—Return request tag-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!—Return result data-->
        </API operation name+response>
    						
  • JSON 形式
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /* Return result data */
        }