パブリックパラメータ - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

パブリックリクエストパラメータ

パブリックリクエストパラメーターは、すべてのインターフェイスが使用する必要があるリクエストパラメーターを指します。

名前	データ型	必須かどうか	説明
Format	String	任意	返された値の型。値: JSONおよびXML。デフォルト値：XML。
Version	String	必須	APIバージョン番号。形式: YYYY-MM-DD (日付) 。現在のバージョン番号は2016-11-01です。
AccessKeyId	String	必須	ユーザーアクセスのためにAlibabaが発行した秘密キーID
Signature	String	必須	署名結果の文字列。署名の計算方法の詳細については、「署名」をご参照ください。
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	必須	署名アルゴリズムのバージョン。 The current version is 1.0
SignatureNonce	String	必須	リプレイ攻撃を防ぐために使用される一意の乱数。異なる要求に対して異なる乱数が使用される。

パブリックリターンパラメータ

呼び出し要求をインターフェイスに送信するたびに、要求が成功したかどうかに関係なく、システムは一意の識別コード (RequestId) を返します。

リクエストの例

https://rds.aliyuncs.com /
形式=xml
&バージョン=2014-08-15
&シグネチャー=Pc5WB8gokVn0xfeu % 2FZV % 2BiNM1dgI % 3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=キーテスト
&OwnerId=12345678
&タイムスタンプ=2014-10-10T12:00:00Z

返された結果

API サービスが呼び出された後、同じ形式でデータが返されます。返された HTTP ステータスコードが 2xx という形式の場合、呼び出しは成功です。返された HTTP ステータスコードが 4xx または 5xx の場合、呼び出しは失敗です。呼び出しが成功した場合、リターンデータの主な形式は XML と JSON の形式です。リクエストが送信されると、外部システムは、返されるデータの形式を定義するパラメータを生成できます。デフォルトではXMLです。このドキュメントでは、返された結果の例は、表示しやすい方法でフォーマットされています。実際に返される結果には、改行とインデントは含まれません。

成功した結果

返されたXML結果には、リクエスト処理結果 (成功または失敗) と特定のサービスデータが含まれます。例:

<? xml version="1.0" encoding="utf-8"? >
<!-- 結果ルートノード -->
<インターフェイス名 + レスポンス>
    <!-- Return Request Tag -->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!-- 返された結果データ -->
</インタフェース名 + 応答>

JSON形式:




    &quot;RequestId&quot;： &quot;4C467B38-3910-447D-87BC-AC049166F216&quot;、
    /* 返された結果データ * /

エラー結果

インターフェイス呼び出しでエラーが発生した場合、結果は返されません。クライアントエラーコードを参照して、エラーの原因を特定できます。

呼び出しでエラーが発生した場合、HTTPリクエストに対してHTTPステータスコード4xxまたは5xxが返されます。返されるメッセージ本文には、エラーコードとエラーメッセージが含まれています。メッセージ本文には、グローバルに一意のRequestIdと要求されたHostIdも含まれます。エラーの原因を特定できない場合は、Alibaba Cloud Customer Serviceに連絡してサポートエンジニアにHostIdとRequestIdを提供して、問題をできるだけ早く解決してください。

XML形式:

<? xml version="1.0" encoding="UTF-8"? >
<エラー>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>rds.aliyuncs.com</HostId>
   <Code> UnsupportedOperation </Code>
   <Message> 指定されたアクションはサポートされていません。</Message>
</エラー>

JSONの例:




    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "rds.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."