このトピックでは、各操作で使用するリクエストパラメーターとレスポンスパラメーターについて説明します。
共通リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
Format | String | いいえ | レスポンスのフォーマット。有効な値: JSON(デフォルト) | XML |
Version | String | はい | API のバージョン番号。YYYY-MM-DD の形式。有効な値: 2018-12-21 |
AccessKeyId | String | はい | SSL 証明書サービスへのアクセスに使用する Alibaba Cloud アカウントの AccessKey ID。 |
Signature | String | はい | 現在のリクエストの署名文字列。 |
SignatureMethod | String | はい | リクエスト署名の作成に使用されるアルゴリズム。有効な値: HMAC-SHA1。 |
Timestamp | String | はい | リクエストが署名されたときのタイムスタンプ。ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式で時間を指定します。 例:2013-01-10T12:00:00Z。 |
SignatureVersion | String | はい | 使用する署名バージョン。有効な値: 1.0。 |
SignatureNonce | String | はい | リプレイ攻撃を防ぐために使用される、一意のランダムに生成された数値。 ユーザーは、リクエストごとに異なる数値を使用する必要があります。 |
ResourceOwnerAccount | String | いいえ | この API リクエストを通じてアクセスされるリソースを所有するアカウントの名前、つまり、ログインしているユーザーの名前。 |
例
http://baas.aliyuncs.com/?Action=DescribeFabricOrganization
&TimeStamp=2018-12-21T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2018-12-21
&SignatureVersion=1.0
&Signature=Signature共通レスポンスパラメーター
レスポンスデータは、JSON または XML 形式で返されます。リクエストでレスポンス形式を指定できます。デフォルトのレスポンス形式は JSON です。すべてのレスポンスには、呼び出しが成功したかどうかに関係なく、一意の RequestId があります。
HTTP ステータスコード
2xxは、呼び出しが成功したことを示します。HTTP ステータスコード
4xxまたは5xxは、呼び出しが失敗したことを示します。
レスポンスの例
XML 形式
<? xml version="1.0" encoding="utf-8"? > <!--レスポンスルートノード--> <API 操作名+response> <!--リクエスト ID--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--レスポンス--> </API 操作名+response>JSON 形式
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /*レスポンス*/ }