DescribeDatabases操作を呼び出して、インスタンスのデータベースに関する情報を照会できます。

説明 指定されたリクエストパラメーターが無効な場合、データベース情報は返されません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目データ型必須／任意例:説明　
操作String必須DescribeDatabases

実行する操作です。 値をDescribeDatabasesに設定します。

DBInstanceIdString必須rm-uf6wjk5xxxxxxx

インスタンスの ID です。

DBNameString任意testDB01

データベースの名前。

DBStatusString任意作成中

データベースのステータス。 有効な値：

  • 作成中
  • 実行中
  • 削除中
PageSizeIntegerいいえ30

各ページで返されるエントリ数。 有効な値：

  • 30
  • 50
  • 100

デフォルト値：30。

PageNumberIntegerいいえ1

返されるページ数。 有効値：0 以外の正の整数。

既定値：1

ResourceGroupIdString任意rg-acfmy *****

リソースグループの ID です。

レスポンスパラメーター

項目データ型例:説明　
RequestIdString2603CA96-B17D-4903-BC04-61A2C829CD94

リクエストの ID です。

データベースデータベースの配列

データベースに関する情報で構成される配列。

データベース
DBDescriptionStringTest database

データベースの説明を記述します。

DBStatusString作成中

データベースのステータス。 有効な値：

  • 作成中
  • 実行中
  • 削除中
DBNameStringtestDB01

データベースの名前。

DBInstanceIdStringrm-uf6wjk5xxxxxxx

データベースが属するインスタンスのID。

EngineStringMySQL

データベースが属するインスタンスのデータベースエンジン。

CharacterSetNameStringutf8

文字セットの名前。

ソート順StringC

文字セットの照合順序。 値Cの例は、ローカリゼーションを表す。

説明 このパラメーターは、PostgreSQLを実行するインスタンスに対してのみ返されます。
CtypeStringen_US.utf8

文字セットのタイプ。

説明 このパラメーターは、PostgreSQLを実行するインスタンスに対してのみ返されます。
ConnLimitString-1

同時リクエストの数の制限。 値-1は、同時リクエストの数に制限がないことを示します。

説明 このパラメーターは、PostgreSQLを実行するインスタンスに対してのみ返されます。
テーブルスペースStringpg_default

データベースのテーブルスペース。

説明 このパラメーターは、PostgreSQLを実行するインスタンスに対してのみ返されます。
ResourceGroupIdStringrg-acfmy *****

リソースグループの ID です。

アカウントAccountPrivilegeInfoの配列

アカウントの詳細で構成される配列。 各アカウントには、データベースに対する特定の権限があります。

AccountPrivilegeInfo
アカウントStringtest

アカウントのユーザー名。

AccountPrivilegeStringDMLOnly

アカウントがデータベースに対して持つ権限。 有効な値：

  • ReadWrite: 読み取りおよび書き込み権限
  • ReadOnly: 読み取り専用の権限
  • DMLOnly: DMLのみの権限
  • DDLOnly: DDLのみの権限
AccountPrivilegeDetailStringSELECT

アカウントがデータベースに対して持つ権限の詳細。

PageNumberInteger1

reservedパラメーター。

PageSizeInteger30

reservedパラメーター。

TotalCountInteger100

返されたエントリの総数。

例

リクエストの例

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 ステータスコードエラーコードエラーメッセージ説明　
400Database.ConnectErrorデータベース接続エラー。 インスタンスのステータスとデータベースのprocesslistを確認してくださいデータベース接続が異常な場合に返されるエラーメッセージ。 データベースのインスタンスステータスと接続プールを確認します。
400Database.QueryErrorDbのクエリに失敗しました。入力値とインスタンスのステータスを確認してくださいデータベースの照会に失敗した場合に返されるエラーメッセージ。 入力パラメーターとインスタンスのステータスを確認します。

エラーコードリストについては、「API エラーセンター」をご参照ください。