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

指定された PolarDB クラスター内のデータベースの詳細を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeDatabases

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。	pc-**************
DBName	string	任意	データベースの名前。説明複数のデータベース名は指定できません。	test_db
PageNumber	integer	任意	返すページ番号。0 より大きい整数で、整数の最大値を超えない値を指定する必要があります。デフォルト値：1。	1
PageSize	integer	任意	各ページに返すエントリ数。有効な値： 30 50 100 デフォルト値：30。	30

レスポンスフィールド

フィールド	型	説明	例
	object
PageRecordCount	integer	現在のページで返されるエントリ数。	1
Databases	object
Database	array<object>	データベースの詳細。
	array<object>
DBDescription	string	データベースの説明。	test_des
DBStatus	string	データベースのステータス。有効な値： Creating：データベースは作成中です。 Running：データベースは使用中です。 Deleting：データベースは削除中です。	Running
DBName	string	データベースの名前。	test_db
Engine	string	データベースエンジンのタイプ。有効な値： MySQL Oracle PostgreSQL	MySQL
MasterID	string	マルチマスタークラスター (データベース/テーブル) 版クラスター内のデータベースのプライマリノードの ID。	2
CharacterSetName	string	文字セット。詳細については、「文字セット」をご参照ください。	utf8mb4
Accounts	object
Account	array<object>	データベースアカウントの詳細。説明 PolarDB for MySQL クラスターの場合、特権アカウントは返されません。
	object
PrivilegeStatus	string	権限付与ステータス。有効な値： Empowering：権限を付与中です。 Empowered：権限が付与されています。 Removing：権限を削除中です。	Empowered
AccountStatus	string	アカウントのステータス。有効な値： Creating：アカウントは作成中です。 Available：アカウントは利用可能です。 Deleting：アカウントは削除中です。	Available
AccountPrivilege	string	アカウントの権限。有効な値： ReadWrite：読み書き。 ReadOnly：読み取り専用。 DMLOnly：DML のみ。 DDLOnly：DDL のみ。 ReadIndex：読み取りとインデックス。	ReadOnly
AccountName	string	アカウントの名前。説明 PolarDB for MySQL クラスターの場合、特権アカウントは返されません。	test_acc
RequestId	string	リクエストの ID。	E1DF8CA6-2300-448B-9ABF-760C4B******
PageNumber	integer	ページ番号。	1

例

成功レスポンス

JSONJSON

{
  "PageRecordCount": 1,
  "Databases": {
    "Database": [
      {
        "DBDescription": "test_des",
        "DBStatus": "Running",
        "DBName": "test_db",
        "Engine": "MySQL",
        "MasterID": "2",
        "CharacterSetName": "utf8mb4",
        "Accounts": {
          "Account": [
            {
              "PrivilegeStatus": "Empowered",
              "AccountStatus": "Available",
              "AccountPrivilege": "ReadOnly",
              "AccountName": "test_acc"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "E1DF8CA6-2300-448B-9ABF-760C4B******",
  "PageNumber": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。