DescribeDatabases操作を呼び出して、インスタンスのデータベースに関する情報を照会できます。
説明 指定されたリクエストパラメーターが無効な場合、データベース情報は返されません。
デバッグ
リクエストパラメーター
項目 | データ型 | 必須/任意 | 例: | 説明 |
---|---|---|---|---|
操作 | String | 必須 | DescribeDatabases | 実行する操作です。 値をDescribeDatabasesに設定します。 |
DBInstanceId | String | 必須 | rm-uf6wjk5xxxxxxx | インスタンスの ID です。 |
DBName | String | 任意 | testDB01 | データベースの名前。 |
DBStatus | String | 任意 | 作成中 | データベースのステータス。 有効な値:
|
PageSize | Integer | いいえ | 30 | 各ページで返されるエントリ数。 有効な値:
デフォルト値:30。 |
PageNumber | Integer | いいえ | 1 | 返されるページ数。 有効値:0 以外の正の整数。 既定値:1 |
ResourceGroupId | String | 任意 | rg-acfmy ***** | リソースグループの ID です。 |
レスポンスパラメーター
項目 | データ型 | 例: | 説明 |
---|---|---|---|
RequestId | String | 2603CA96-B17D-4903-BC04-61A2C829CD94 | リクエストの ID です。 |
データベース | データベースの配列 | データベースに関する情報で構成される配列。 | |
データベース | |||
DBDescription | String | Test database | データベースの説明を記述します。 |
DBStatus | String | 作成中 | データベースのステータス。 有効な値:
|
DBName | String | testDB01 | データベースの名前。 |
DBInstanceId | String | rm-uf6wjk5xxxxxxx | データベースが属するインスタンスのID。 |
Engine | String | MySQL | データベースが属するインスタンスのデータベースエンジン。 |
CharacterSetName | String | utf8 | 文字セットの名前。 |
ソート順 | String | C | 文字セットの照合順序。 値Cの例は、ローカリゼーションを表す。 説明 このパラメーターは、PostgreSQLを実行するインスタンスに対してのみ返されます。 |
Ctype | String | en_US.utf8 | 文字セットのタイプ。 説明 このパラメーターは、PostgreSQLを実行するインスタンスに対してのみ返されます。 |
ConnLimit | String | -1 | 同時リクエストの数の制限。 値-1は、同時リクエストの数に制限がないことを示します。 説明 このパラメーターは、PostgreSQLを実行するインスタンスに対してのみ返されます。 |
テーブルスペース | String | pg_default | データベースのテーブルスペース。 説明 このパラメーターは、PostgreSQLを実行するインスタンスに対してのみ返されます。 |
ResourceGroupId | String | rg-acfmy ***** | リソースグループの ID です。 |
アカウント | AccountPrivilegeInfoの配列 | アカウントの詳細で構成される配列。 各アカウントには、データベースに対する特定の権限があります。 | |
AccountPrivilegeInfo | |||
アカウント | String | test | アカウントのユーザー名。 |
AccountPrivilege | String | DMLOnly | アカウントがデータベースに対して持つ権限。 有効な値:
|
AccountPrivilegeDetail | String | SELECT | アカウントがデータベースに対して持つ権限の詳細。 |
PageNumber | Integer | 1 | reservedパラメーター。 |
PageSize | Integer | 30 | reservedパラメーター。 |
TotalCount | Integer | 100 | 返されたエントリの総数。 |
例
リクエストの例
http(s):// rds.aliyuncs.com/?Action=DescribeDatabases
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<共通リクエストパラメーター>
正常に処理された場合のレスポンス例
XML
形式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<DescribeDatabasesResponse>
<RequestId>2603CA96-B17D-4903-BC04-61A2C829CD94</RequestId>
<Databases>
<Database>
<Engine>MySQL</Engine>
<CharacterSetName>utf8</CharacterSetName>
<DBStatus> 作成中 </DBStatus>
<DBDescription></DBDescription>
<DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>
<アカウント></アカウント>
<DBName>testdb</DBName>
</Database>
<Database>
<Engine>MySQL</Engine>
<CharacterSetName>gbk</CharacterSetName>
<DBStatus> 作成中 </DBStatus>
<DBDescription></DBDescription>
<DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>
<アカウント></アカウント>
<DBName>testdb2</DBName>
</Database>
</Databases></DescribeDatabasesResponse>
JSON
形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "2603CA96-B17D-4903-BC04-61A2C829CD94" 、
"データベース" : {
"データベース" : [ {
"エンジン" : "MySQL" 、
"CharacterSetName" : "utf8" 、
"DBStatus" : "Creating" 、
"DBDescription" : "" 、
"DBInstanceId" : "rdsaiiabnaiiabn" 、
"アカウント" : {
"AccountPrivilegeInfo" : [ ]
},
"DBName" : "testdb"
}, {
"エンジン" : "MySQL" 、
"CharacterSetName" : "gbk" 、
"DBStatus" : "Creating" 、
"DBDescription" : "" 、
"DBInstanceId" : "rdsaiiabnaiiabn" 、
"アカウント" : {
"AccountPrivilegeInfo" : [ ]
},
"DBName" : "testdb2"
} ]
}
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
400 | Database.ConnectError | データベース接続エラー。 インスタンスのステータスとデータベースのprocesslistを確認してください | データベース接続が異常な場合に返されるエラーメッセージ。 データベースのインスタンスステータスと接続プールを確認します。 |
400 | Database.QueryError | Dbのクエリに失敗しました。入力値とインスタンスのステータスを確認してください | データベースの照会に失敗した場合に返されるエラーメッセージ。 入力パラメーターとインスタンスのステータスを確認します。 |
エラーコードリストについては、「API エラーセンター」をご参照ください。