DescribeDatabasesZonal でゾーン別に ENS クラスターのデータベースをクエリ - PolarDB

PolarDB for Edge Cloud クラスター内のデータベースについて説明します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID です。	pc-**************
DBName	string	任意	データベース名です。	test_db
PageNumber	integer	任意	ページ番号です。値は 0 より大きい整数で、Integer データ型の最大値を超えないようにする必要があります。デフォルト値は 1 です。	1
PageSize	integer	任意	各ページで返されるエントリ数です。有効な値: 30 50 100 デフォルト値は 30 です。	30
MaxResults	integer	任意	現在のリクエストで返されるエントリの最大数です。	10
NextToken	string	任意	クエリトークンです。これは、前の API 呼び出しの NextToken 値です。結果がこれ以上ない場合は、このパラメーターを指定しないでください。	212db86sca4384811e0b5e8707e******

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
PageRecordCount	integer	現在のページで返されたエントリ数です。	7
Databases	array<object>	データベースの詳細です。
	object
DBDescription	string	データベースの説明です。	test_des
DBStatus	string	データベースのステータスです。有効な値: Creating Running Deleting	Running
DBName	string	データベースの名前です。	test_db
Engine	string	データベースエンジンのタイプです。有効な値: MySQL Oracle PostgreSQL	MySQL
MasterID	string	Multi-master Cluster (Database/Table) エディションのクラスター内のデータベースに対応するプライマリノードの ID です。	2
CharacterSetName	string	文字セットです。	utf8mb4
Accounts	array<object>	データベースアカウントの詳細です。説明クラスターが PolarDB for MySQL クラスターの場合、特権アカウントは含まれません。
	object
PrivilegeStatus	string	権限付与のステータスです。有効な値: Empowering: 権限を付与しています。 Empowered: 権限が付与されています。 Removing: 権限を取り消しています。	Empowered
AccountStatus	string	アカウントのステータスです。有効な値: Creating Available Deleting	Available
AccountPrivilege	string	アカウントの権限です。有効な値: ReadWrite ReadOnly DMLOnly DDLOnly ReadIndex	ReadOnly
AccountName	string	アカウント名です。説明クラスターが PolarDB for MySQL クラスターの場合、特権アカウントは含まれません。	test_acc
RequestId	string	リクエスト ID です。	2FED790E-FB61-4721-8C1C-07C627******
PageNumber	integer	ページ番号です。	1
MaxResults	integer	現在のリクエストで返されるエントリの最大数です。	10
NextToken	string	クエリトークンです。これは、前の API 呼び出しの NextToken 値です。結果がこれ以上ない場合は、このパラメーターを指定しないでください。	212db86sca4384811e0b5e8707e******

例

成功レスポンス

JSONJSON

{
  "PageRecordCount": 7,
  "Databases": [
    {
      "DBDescription": "test_des",
      "DBStatus": "Running",
      "DBName": "test_db",
      "Engine": "MySQL",
      "MasterID": "2",
      "CharacterSetName": "utf8mb4",
      "Accounts": [
        {
          "PrivilegeStatus": "Empowered",
          "AccountStatus": "Available",
          "AccountPrivilege": "ReadOnly",
          "AccountName": "test_acc"
        }
      ]
    }
  ],
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627******",
  "PageNumber": 1,
  "MaxResults": 10,
  "NextToken": "212db86sca4384811e0b5e8707e******"
}

エラーコード

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.

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

変更履歴

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