ListLogicDatabases API を介した論理データベースのリスト化とページ分割 - DMS

論理データベースの詳細情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:ListLogicDatabases

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナントの ID。GetUserActiveTenant 操作を呼び出して、テナント ID を照会できます。	3***
PageNumber	integer	任意	返されるページ番号。	1
PageSize	integer	任意	各ページで返されるエントリ数。	50

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	論理データベースの総数。	7
LogicDatabaseList	object
LogicDatabase	array<object>	論理データベースの詳細。
	array<object>	論理データベースの詳細。
DatabaseId	string	論理データベースの ID。	1***
OwnerIdList	object
OwnerIds	array	論理データベースのオーナーの ID。
	string	論理データベースのオーナー ID。	51****
DbType	string	論理データベースのタイプ。このパラメーターの有効な値の詳細については、「DbType パラメーター」をご参照ください。	POLARDB
OwnerNameList	object
OwnerNames	array	論理データベースのオーナーの名前。
	string	論理データベースのオーナーの名前。	owner_name
Logic	boolean	データベースが論理データベースであるかどうかを示します。戻り値は true です。	true
SchemaName	string	論理データベースの名前。	logic_db
SearchName	string	論理データベースの検索に使用される名前。説明ビジネス開発にこのパラメーターを使用しないことを推奨します。パラメーター値のフォーマットは、以降のバージョンで変更される可能性があります。	logic_db[logic_db_alias]
EnvType	string	論理データベースが属する環境のタイプ。有効な値： product：本番環境 dev：開発環境 pre：ステージング環境 test：テスト環境 sit：システム統合テスト (SIT) 環境 uat：ユーザー受け入れテスト (UAT) 環境 pet：ストレステスト環境 stag：STAG 環境	test
Alias	string	論理データベースのエイリアス。	logic_db_alias
DatabaseIds	object
DatabaseIds	array	論理データベースのサブ ID のリスト。
	integer	論理データベースのサブ ID。	12****
RequestId	string	リクエストの ID。	8068AF82-8A1A-592C-AC2E-6B75338BAB87
ErrorCode	string	返されるエラーコード。	UnknownError
ErrorMessage	string	返されるエラーメッセージ。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功です。 false：リクエストは失敗です。	true

例

成功レスポンス

JSONJSON

{
  "TotalCount": 7,
  "LogicDatabaseList": {
    "LogicDatabase": [
      {
        "DatabaseId": "1***",
        "OwnerIdList": {
          "OwnerIds": [
            "51****"
          ]
        },
        "DbType": "POLARDB",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "Logic": true,
        "SchemaName": "logic_db",
        "SearchName": "logic_db[logic_db_alias]",
        "EnvType": "test",
        "Alias": "logic_db_alias",
        "DatabaseIds": {
          "DatabaseIds": [
            0
          ]
        }
      }
    ]
  },
  "RequestId": "8068AF82-8A1A-592C-AC2E-6B75338BAB87",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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