共通リクエストパラメータ
共通リクエストパラメータは各APIに使用されるリクエストパラメータです
名前 | データ型 | 必須/省略可能 | 説明 |
---|---|---|---|
Format | String | 省略可能 | レスポンステキストの形式です。 有効値:
JSON (デフォルト) | XML |
Version | String | 必須 | API バージョン番号を日付形式 YYYY-MM-DD で示します。 有効値:
2014-05-15 |
AccessKeyId | String | 必須 | API を呼び出すユーザーの AccessKey ID です。 |
Signature | String | 必須 | 署名結果の文字列。 |
SignatureMethod | String | はい | リクエスト署名の作成に使用するアルゴリズムです。 有効値:
HMAC-SHA1 |
Timestamp | String | 必須 | リクエストのタイムスタンプを YYYY-MM-DDThh:mm:ssZ の形式で表示します。
たとえば、2013-01-10T12:00: 00Z です。 |
SignatureVersion | String | 必須 | 使用される署名バージョンです。 有効値:
1.0 |
SignatureNonce | String | 必須 | オンライン反射攻撃を回避するために使用される一意の乱数です。
リクエストごとに一意の乱数を使用する必要があります。 |
ResourceOwnerAccount | String | 省略可能 | API リクエストによってアクセスされるリソースオーナーのアカウント、つまり、ログインのユーザー名を示します。 |
例
http://slb.aliyuncs.com/?Action=DescribeLoadBalancers
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format = xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2014-05-15
&SignatureVersion=1.0
&Signature=Signature
共通レスポンスパラメータ
API レスポンスには統一形式が使用されます。 2XX HTTP ステータスコードが返される場合、呼び出しが成功したことを示します。 4xx または 5xxHTTP ステータスコードが返される場合、呼び出しが失敗したことを示します。 呼び出しが成功した場合、データは XML と JSON のいずれかの形式で返されます。 リクエストを送信するときに、返される結果データの形式を指定することができます。 デフォルトの形式は XML です。
呼び出しの成功に関係なく、システムはリクエストを送信するたびに固有の識別コード (RequestId) を返します。- XML 形式
<? xml version="1.0" encoding="utf-8"? > <!—The root node of the result--> <Action+Response> <!—The returned request tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!—The returned result--> </Action+Response>
- JSON 形式
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /*The returned result*/ }