DescribeDatabases - - Alibaba Cloud ドキュメントセンター

リクエストパラメーターの値の種類が正しくない場合、エラー応答が返され、データは照会されません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター


パラメーター	データ型	必須項目	例	説明
DBClusterId	String	必須	pc-xxxxxxxxxxxxxxx	クラスターの ID。
AccessKeyId	String	任意	key-test	Alibaba Cloud から提供された AccessKey ID。
Action	String	任意	DescribeDatabases	実行する操作。この値を DescribeDatabases に設定します。
DBName	String	任意	test_db_4	データベースの名前。注複数のデータベース名を入力することはできません。

レスポンスパラメーター


パラメーター	データ型	例	説明
Databases	Array		データベースのリスト。
Database			各データベースの詳細。
Accounts	Array		データベースアカウントのリスト。注特権アカウントは含まれません。
Account			各データベースアカウントの詳細。注特権アカウントは含まれません。
AccountName	String	test_admin	アカウントの名前。注特権アカウントは含まれません。
AccountPrivilege	String	ReadWrite	データベースに対するデータベースアカウントの権限。 ReadWrite：読み書き権限。 ReadOnly：読み取り専用権限。 DMLOnly：データ操作言語 (DML) 文のみを実行。 DDLOnly：データ定義言語 (DDL) 文のみを実行。
AccountStatus	String	Available	アカウントのステータス。設定可能な値は以下のとおりです。 Creating Available Deleting
PrivilegeStatus	String	Empowered	データベースアカウントの権限ステータス。設定可能な値は以下のとおりです。 Empowering：システムはアカウントに権限を付与中です。 Empowered：権限はアカウントに付与されています。 Removing：システムはアカウントの権限を取り消し中です。
CharacterSetName	String	utf8	文字セット。詳細については、「文字セット」をご参照ください。
DBDescription	String	test_db	データベースの説明。
DBName	String	test_db_4	データベースの名前
DBStatus	String	Running	データベースのステータス。設定可能な値は以下のとおりです。 Creating Running Deleting
Engine	String	PolarDB	クラスターのエンジン。
RequestId	String	EB88083B-AEE7-44B1-9AEB-E76337B1B236	リクエストの ID。

例

リクエストの例


http(s)://[Endpoint]/? Action=DescribeDatabases
&DBClusterId=pc-xxxxxxxxxxxxxxx
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式

<DescribeDatabasesResponse>
      <Databases>
            <Database>
                  <Accounts>
                        <Account>
                              <AccountPrivilege>ReadWrite</AccountPrivilege>
                              <AccountStatus>Available</AccountStatus>
                              <AccountName>test_admin</AccountName>
                              <PrivilegeStatus>Empowered</PrivilegeStatus>
                        </Account>
                  </Accounts>
                  <DBStatus>Running</DBStatus>
                  <DBDescription></DBDescription>
                  <DBName>test_db_4</DBName>
                  <Engine>PolarDB</Engine>
                  <CharacterSetName>utf8</CharacterSetName>
            </Database>
      </Databases>
      <RequestId>6A83E8E9-D5C4-45CE-85CD-B0A3B2F21F5E</RequestId>
</DescribeDatabasesResponse>

JSON 形式

{
	"successResponse":true,
	"requestId":"EB88083B-AEE7-44B1-9AEB-E76337B1B236",
	"data":{
		"Databases":{
			"Database":[
				{
					"Accounts":{
						"Account":[
							{
								"AccountPrivilege":"ReadWrite",
								"AccountStatus":"Available",
								"AccountName":"test_a",
								"PrivilegeStatus":"Empowered"
							},
							{
								"AccountPrivilege":"ReadOnly",
								"AccountStatus":"Available",
								"AccountName":"test_acc",
								"PrivilegeStatus":"Empowered"
							}
						]
					},
					"DBStatus":"Running",
					"DBDescription":"",
					"DBName":"test_db_2",
					"Engine":"PolarDB",
					"CharacterSetName":"utf8"
				},
				{
					"Accounts":{
						"Account":[
							{
								"AccountPrivilege":"ReadWrite",
								"AccountStatus":"Available",
								"AccountName":"test_acc",
								"PrivilegeStatus":"Empowered"
							}
						]
					},
					"DBStatus":"Running",
					"DBDescription":"",
					"DBName":"test_db_5",
					"Engine":"PolarDB",
					"CharacterSetName":"utf8mb4"
				}
			]
		},
		"RequestId":"EB88083B-AEE7-44B1-9AEB-E76337B1B236"
	},
	"code":"200"
}

エラーコード

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