GetPhysicalDatabase による物理データベース詳細の検索 - 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:GetPhysicalDatabase

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DbId	integer	必須	物理データベースの ID です。ID を取得するには、SearchDatabase 操作を呼び出します。	43153
Tid	integer	任意	テナントの ID です。テナントの ID を照会するには、GetUserActiveTenant 操作を呼び出します。	1

レスポンスフィールド

フィールド	型	説明	例
	object	応答データです。
RequestId	string	リクエストの ID です。	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
Database	object	物理データベースの情報です。
DatabaseId	string	物理データベースの ID です。	43125312
Host	string	データベースに接続するために使用されるエンドポイントです。	rm-xxxab3r272.mysql.rds.aliyuncs.com
CatalogName	string	データベースが属するカタログの名前です。説明 : PostgreSQL データベースの場合、データベース名が表示されます。	def
DbaName	string	ターゲットデータベースにおけるデータベース管理者 (DBA) のニックネームです。	dmstest
State	string	データベースの状態です。有効な値は以下のとおりです。 NORMAL: データベースは正常です。 DISABLE: データベースは無効化されています。 OFFLINE: データベースは非公開です。 NOT_EXIST: データベースは存在しません。	NORMAL
DbaId	string	ターゲットデータベースにおける DBA のユーザー ID です。	43253
SchemaName	string	データベースの名前です。説明 : PostgreSQL データベースの場合、スキーマ名が表示されます。	dmstest
InstanceId	string	ターゲットデータベースのインスタンス ID です。	43215325
Port	integer	データベースに接続するために使用されるポート番号です。	3306
EnvType	string	データベースが属する環境の種別です。詳細については、「インスタンスの環境タイプの変更」をご参照ください。	product
Sid	string	データベースのシステム ID (SID) です。説明 : このパラメーターの値は、Oracle データベースのみで返されます。	def
OwnerIdList	object
OwnerIds	array	データベース所有者のユーザー ID です。
	string	データベース所有者のユーザー ID です。	43215325
Encoding	string	データベースのエンコード形式です。	utf8mb4
DbType	string	データベースエンジンの種別です。	mysql
OwnerNameList	object
OwnerNames	array	データベース所有者のニックネームです。
	string	データベース所有者のニックネームです。	dmstest
SearchName	string	データベースを検索するために使用される名前です。	dmstest@rm-xxxab3r272.mysql.rds.aliyuncs.com:3306
InstanceAlias	string	データベースインスタンスのエイリアスです。	test
ErrorCode	string	リクエストが失敗した場合に返されるエラーコードです。	UnknownError
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージです。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "Database": {
    "DatabaseId": "43125312",
    "Host": "rm-xxxab3r272.mysql.rds.aliyuncs.com",
    "CatalogName": "def",
    "DbaName": "dmstest",
    "State": "NORMAL",
    "DbaId": "43253",
    "SchemaName": "dmstest",
    "InstanceId": "43215325",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "def",
    "OwnerIdList": {
      "OwnerIds": [
        "43215325"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "dmstest"
      ]
    },
    "SearchName": "dmstest@rm-xxxab3r272.mysql.rds.aliyuncs.com:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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