# Amazon RDS API リファレンス
<a name="ProgrammingGuide"></a>

AWS マネジメントコンソール と AWS Command Line Interface (AWS CLI) の他に、Amazon RDS には API も用意されています。API を使用して、DB インスタンスと Amazon RDS の他のオブジェクトを管理するためのタスクを自動化できます。
+ API オペレーションのアルファベット順リストについては、「[アクション](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html)」を参照してください。
+ データ型のアルファベット順リストについては、「[データ型](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html)」を参照してください。
+ 共通クエリパラメータのリストについては、「[共通パラメータ](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html)」を参照してください。
+ エラーコードの説明については、「[共通エラー](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html)」を参照してください。

AWS CLI の詳細については、「[Amazon RDS の AWS Command Line Interface リファレンス](https://docs.aws.amazon.com/cli/latest/reference/rds/index.html)」を参照してください。

**Topics**
+ [

# クエリ API の使用
](Using_the_Query_API.md)
+ [

# Amazon RDS のアプリケーションのトラブルシューティング
](APITroubleshooting.md)

# クエリ API の使用
<a name="Using_the_Query_API"></a>

以下のセクションでは、Query API で使用されるパラメータおよびリクエスト認証について簡単に説明します。

Query API の動作に関する一般的な情報については、*Amazon EC2 API Reference*の「[クエリリクエスト](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html)」を参照してください。

## クエリパラメータ
<a name="query-parameters"></a>

HTTP クエリベースのリクエストとは、HTTP 動詞 (GET または POST) とクエリパラメータ `Action` で記述する HTTP リクエストです。

各クエリリクエストに、アクションの認証と選択を処理するための一般的なパラメータがいくつか含まれている必要があります。

オペレーションの中にはパラメータのリストを取るものがあります。これらのリストは、`param.n` 表記を使用して指定されます。*n* 値は、1 から始まる整数です。

Amazon RDS のリージョンとエンドポイントの詳細については、*Amazon Web Services 全般のリファレンス* の「リージョンとエンドポイント」セクションの「[Amazon Relational Database Service (RDS)](https://docs.aws.amazon.com/general/latest/gr/rande.html#rds_region)」を参照してください。

## クエリリクエストの認証
<a name="query-authentication"></a>

HTTPS 経由でのみリクエストを送信できます。また、各クエリリクエストには署名を含める必要があります。AWS 署名バージョン 4 または署名バージョン 2 のどちらかを使用してください。詳細については、「[署名バージョン 4 の署名プロセス](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)」および「[署名バージョン 2 の署名プロセス](https://docs.aws.amazon.com/general/latest/gr/signature-version-2.html)」を参照してください。

# Amazon RDS のアプリケーションのトラブルシューティング
<a name="APITroubleshooting"></a>

Amazon RDS では、Amazon RDS API とのやり取りで発生する問題をトラブルシューティングする際に役立つ、具体的でわかりやすいエラーを提供します。

**Topics**
+ [

## エラーの取得
](#RetrievingErrors)
+ [

## トラブルシューティングのヒント
](#TroubleshootingTipss)

 Amazon RDS DB インスタンスのトラブルシューティングの詳細については、「[Amazon RDS のトラブルシューティング](CHAP_Troubleshooting.md)」を参照してください。

## エラーの取得
<a name="RetrievingErrors"></a>

通常、アプリケーションでは、結果を処理する前にリクエストでエラーが生成されたかどうかを必ず確認します。エラーが発生したかどうかを確認する最も簡単な方法は、Amazon RDS API からのレスポンスで `Error` ノードを検索することです。

XPath 構文を使用すると、簡単な方法で 1 つの `Error` ノードがあるかどうかを検索します。また、エラーコードとメッセージを比較的簡単に取得できます。次のコードでは、Perl および XML::XPath モジュールによって、リクエスト時のエラーの発生を判定しています。エラーが発生した場合、レスポンス内の最初のエラーコードとメッセージが表示されます。

```
use XML::XPath; 
    my $xp = XML::XPath->new(xml =>$response); 
    if ( $xp->find("//Error") ) 
    {print "There was an error processing your request:\n", " Error code: ",
    $xp->findvalue("//Error[1]/Code"), "\n", " ",
    $xp->findvalue("//Error[1]/Message"), "\n\n"; }
```

## トラブルシューティングのヒント
<a name="TroubleshootingTipss"></a>

 Amazon RDS API の問題を診断して解決するには、次の手順を実行することをお勧めします。
+ [http://status.aws.amazon.com](https://status.aws.amazon.com/) を確認し、対象とする AWS リージョンで Amazon RDS が正常に動作しているかどうかを確認します。
+ リクエストの構文を確認します。

  『*Amazon RDS API リファレンス*』には、各 Amazon RDS オペレーションについてのリファレンスページがあります。パラメータを正しく使用していることをもう一度確認してください。間違っている可能性がある部分を判断するヒントとして、同様のオペレーションを実行しているサンプルのリクエストやユーザーシナリオを調べてください。
+ AWS re:Post を確認する

  Amazon RDS には開発コミュニティあり、これまでに他のデベロッパーが経験した問題に対する解決策を探すことができます。トピックを表示するには、[AWS re:Post](https://repost.aws/) に移動してください。