論理データベース用の GetLogicDatabase API リファレンス - Data Management (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:GetLogicDatabase

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナントの ID です。説明テナントの ID を確認するには、Data Management (DMS) コンソールにログインし、右上隅のプロフィール画像にカーソルを合わせます。詳細については、「現在のテナントに関する情報の表示」をご参照ください。	3***
DbId	string	必須	論理データベースの ID です。論理データベースの ID を取得するには、ListLogicDatabases または SearchDatabase 操作を呼び出します。	1***

レスポンスフィールド

フィールド	型	説明	例
	object
LogicDatabase	object	論理データベースの詳細情報です。
DatabaseId	string	論理データベースの ID です。	1***
OwnerIdList	object
OwnerIds	array	論理データベースのオーナーの ID です。
	string	論理データベースのオーナーの ID です。	51****
DbType	string	データベースエンジンです。「DbType」パラメーターの有効な値については、「DbType パラメーター」をご参照ください。	POLARDB
OwnerNameList	object
OwnerNames	array	論理データベースのオーナーの名前です。
	string	論理データベースのオーナーの名前です。	owner_name
Logic	boolean	データベースが論理データベースであるかどうかを示します。戻り値は true です。	true
SchemaName	string	論理データベースの名前です。	test_logic_db
SearchName	string	論理データベースを検索するために使用される名前です。	test_logic_db[test_logic_alias]
EnvType	string	データベースが属する環境の種類です。有効な値は以下のとおりです。 product：本番環境 dev：開発環境 pre：プレリリース環境 test：テスト環境 sit：システム統合テスト（SIT）環境 uat：ユーザ受入テスト（UAT）環境 pet：ストレステスト環境 stag：ステージング環境	dev
Alias	string	論理データベースのエイリアスです。	test_logic_alias
DatabaseIds	object
DatabaseIds	array	論理データベースのデータベースシャードの ID です。
	integer	論理データベースのデータベースシャードの ID です。	12****
RequestId	string	リクエストの ID です。	90260530-565C-42B9-A6E8-893481FE6AB6
ErrorCode	string	状態コードです。	UnknownError
ErrorMessage	string	エラーメッセージです。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "LogicDatabase": {
    "DatabaseId": "1***",
    "OwnerIdList": {
      "OwnerIds": [
        "51****"
      ]
    },
    "DbType": "POLARDB",
    "OwnerNameList": {
      "OwnerNames": [
        "owner_name"
      ]
    },
    "Logic": true,
    "SchemaName": "test_logic_db",
    "SearchName": "test_logic_db[test_logic_alias]",
    "EnvType": "dev",
    "Alias": "test_logic_alias",
    "DatabaseIds": {
      "DatabaseIds": [
        0
      ]
    }
  },
  "RequestId": "90260530-565C-42B9-A6E8-893481FE6AB6",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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