DescribeDatabases - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud ドキュメントセンター

このオペレーションを呼び出すと、テナント内のデータベースをクエリできます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DescribeDatabases

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TenantId	string	任意	テナントの ID です。	t4pnum****
PageNumber	integer	任意	ページ番号です。開始値： 1 デフォルト値： 1	1
PageSize	integer	任意	1 ページあたりの行数です。最大値： 100 デフォルト値： 10	10
DatabaseName	string	任意	データベースの名前です。 test や mysql などの予約語は使用できません。	sms_pre
SearchKey	string	任意	検索キーワードです。	pay
WithTables	boolean	任意	データベース内のテーブルに関する情報を返すかどうかを指定します。デフォルト値は false です。説明データベースに多数のテーブルが含まれている場合、この操作はタイムアウトすることがあります。	true
InstanceId	string	任意	クラスターの ID です。	ob****n0abo9uo

レスポンスフィールド

フィールド	型	説明	例
	object	リクエストの戻り値です。
TotalCount	integer	テナント内のデータベース総数です。	1
Databases	array<object>	テナント内のデータベースの一覧です。
	array<object>	テナント内のデータベースの一覧です。
Status	string	データベースのステータスです。有効な値： ONLINE ：データベースは実行中です。 DELETING ：データベースを削除中です。	ONLINE
Description	string	データベースの説明です。	test db
Encoding	string	データベースのエンコーディングです。`utf8mb4` や `GBK` などがサポートされています。	utf8mb4
DbType	string	データベースのタイプです。	mysql
DatabaseName	string	データベース名です。	sms_pre
CreateTime	string	データベースの作成時刻です。	2022-02-21 15:41:06
Users	array<object>	このデータベースに対する権限を持つアカウントの一覧です。
	object	このデータベースに対する権限を持つアカウントの一覧です。
UserType	string	アカウントのタイプです。有効な値： Admin ：スーパー管理者アカウントです。 Normal ：一般アカウントです。	Normal
Role	string	アカウントのロールです。 MySQL モードでは、データベースレベルのロールになります。有効な値： ReadWrite ：読み書き権限 (`ALL PRIVILEGES`) を持つロールです。 ReadOnly ：読み取り専用の `SELECT` 権限のみを持つロールです。 DDL ：`CREATE`、`DROP`、`ALTER`、`SHOW VIEW`、`CREATE VIEW` などの DDL 権限を持つロールです。 DML ：`SELECT`、`INSERT`、`UPDATE`、`DELETE`、`SHOW VIEW` などの DML 権限を持つロールです。	ReadOnly
UserName	string	アカウント名です。	user_pay_ro
Privileges	string	データベースにカスタム権限を付与している場合、このパラメーターにカスタム権限がカンマ (,) 区切りで返されます。それ以外の場合、このパラメーターは返されません。	select,delete,update
TenantId	string	テナントの ID です。	t4pnum****
Tables	array<object>	データベーステーブルの一覧です。
	object	データベーステーブルの一覧です。
TableName	string	データベーステーブル名です。	testTables
RequiredSize	number	必要なストレージ領域 (GB) です。	5.67 GB
DataSize	number	実際のデータサイズ (GB) です。重要このパラメーターは以降のバージョンでは使用されません。代わりに `RequiredSize` を使用してください。	5.67 GB
Collation	string	照合順序です。	utf8mb4_general_ci
InstanceId	string	テナントが属するクラスターの ID です。	obsdh2f****
TenantName	string	テナント名です。	tenantABC
RequestId	string	リクエスト ID です。	EE205C00-30E4-**-**-87E3A8A2AA0C

例

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "Databases": [
    {
      "Status": "ONLINE",
      "Description": "test db",
      "Encoding": "utf8mb4",
      "DbType": "mysql",
      "DatabaseName": "sms_pre",
      "CreateTime": "2022-02-21 15:41:06",
      "Users": [
        {
          "UserType": "Normal",
          "Role": "ReadOnly",
          "UserName": "user_pay_ro",
          "Privileges": "select,delete,update"
        }
      ],
      "TenantId": "t4pnum****",
      "Tables": [
        {
          "TableName": "testTables"
        }
      ],
      "RequiredSize": 0,
      "DataSize": 0,
      "Collation": "utf8mb4_general_ci",
      "InstanceId": "obsdh2f****",
      "TenantName": "tenantABC"
    }
  ],
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

エラーコード

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

変更履歴

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