すべてのプロダクト
Search
ドキュメントセンター

Data Management:GetInstance

最終更新日:Mar 21, 2026

指定されたインスタンスの詳細情報を取得します。

今すぐお試しください

この 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:GetInstance

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Tid

integer

任意

テナント ID。この値を取得するには、GetUserActiveTenant 操作を呼び出します。

2***

Host

string

必須

インスタンスのエンドポイント。この値を取得するには、ListInstances 操作を呼び出します。

172.17.XXX.XXX

Port

integer

必須

インスタンスのポート番号。この値を取得するには、ListInstances 操作を呼び出します。

5432

Sid

string

任意

インスタンスのシステム ID (SID)。この値を取得するには、ListInstances 操作を呼び出します。

test

RealLoginUserUid

string

任意

このパラメーターは予約済みです。

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

F6C80B69-3203-56AC-8021-18BA72A6F4E1

Instance

object

インスタンスの詳細情報。

VpcId

string

インスタンスが属する VPC の ID。

vpc-o6wrloqsdqc9io3mg****

DatabaseUser

string

インスタンスへのログインに使用するユーザー名。

dbuser

DbaId

string

インスタンスのデータベース管理者 (DBA) の ID。

29****

UseDsql

integer

インスタンスでクロスデータベースクエリが有効化されているかどうかを示します。有効な値:

  • 0:無効

  • 1:有効

0

Port

integer

インスタンスへの接続に使用されるポート番号。

5432

EcsInstanceId

string

データベースインスタンスがデプロイされている ECS インスタンスの ID。

i-bp124ldpklqz59y3****

EnvType

string

インスタンスが属する環境の種類。有効な値:

  • product:本番環境

  • dev:開発環境

  • pre:プレリリース環境

  • test:テスト環境

  • sit:システム統合テスト (SIT) 環境

  • uat:ユーザ受入テスト (UAT) 環境

  • pet:性能テスト環境

  • stag:ステージング環境

test

Sid

string

インスタンスのシステム ID (SID)。

test

OwnerIdList

object

インスタンス所有者の ID。

OwnerIds

array

インスタンス所有者のユーザー ID。

string

インスタンス所有者のユーザー ID。

10****

SafeRuleId

string

インスタンスに適用されるセキュリティルールセットの ID。

3****

OwnerNameList

object

インスタンス所有者のニックネーム。

OwnerNames

array

インスタンス所有者のニックネーム。

string

インスタンス所有者のニックネーム。

yang_test

DbaNickName

string

インスタンスの DBA のニックネーム。

dbaname

QueryTimeout

integer

インスタンスにおけるデータクエリのタイムアウト期間。単位:秒。

7200

InstanceSource

string

インスタンスのソース。

ECS_OWN

Host

string

インスタンスへの接続に使用されるエンドポイント。

192.168.XXX.XXX

State

string

インスタンスの状態。有効な値:

  • NORMAL:正常に実行中

  • DISABLE:無効化済み

NORMAL

DataLinkName

string

インスタンスのデータリンク名。

test

ExportTimeout

integer

インスタンスからのデータエクスポートのタイムアウト期間。単位:秒。

86400

InstanceId

string

インスタンスの ID。

188****

InstanceType

string

データベースの種類。

postgresql

DatabasePassword

string

ユーザー名に対応するパスワード。

******

InstanceAlias

string

インスタンスのエイリアス。

测试

DdlOnline

integer

インスタンスでロックフリーのスキーマ変更が有効化されているかどうかを示します。

0

EcsRegion

string

インスタンスが存在するリージョン。

cn-beijing

StandardGroup

object

インスタンスのコントロールモード。

GroupName

string

コントロールモードに対応するセキュリティルールセットの名称。

自由操作

GroupMode

string

コントロールモード。有効な値:

  • COMMON:セキュリティコラボレーション

  • NONE_CONTROL:柔軟な管理

  • STABLE:安定的な変更

NONE_CONTROL

SellSitd

string

機密データ保護が有効化されているかどうかを示します。有効な値:

  • true:有効

  • false:無効

false

SellTrust

string

このパラメーターは予約済みです。

ErrorCode

string

返されたエラーコード。

UnknownError

ErrorMessage

string

返されたエラーメッセージ。

UnknownError

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true

  • false

true

成功レスポンス

JSONJSON

{
  "RequestId": "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance": {
    "VpcId": "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser": "dbuser",
    "DbaId": "29****",
    "UseDsql": 0,
    "Port": 5432,
    "EcsInstanceId": "i-bp124ldpklqz59y3****",
    "EnvType": "test",
    "Sid": "test",
    "OwnerIdList": {
      "OwnerIds": [
        "10****"
      ]
    },
    "SafeRuleId": "3****",
    "OwnerNameList": {
      "OwnerNames": [
        "yang_test"
      ]
    },
    "DbaNickName": "dbaname",
    "QueryTimeout": 7200,
    "InstanceSource": "ECS_OWN",
    "Host": "192.168.XXX.XXX",
    "State": "NORMAL",
    "DataLinkName": "test",
    "ExportTimeout": 86400,
    "InstanceId": "188****",
    "InstanceType": "postgresql",
    "DatabasePassword": "******",
    "InstanceAlias": "测试",
    "DdlOnline": 0,
    "EcsRegion": "cn-beijing",
    "StandardGroup": {
      "GroupName": "自由操作",
      "GroupMode": "NONE_CONTROL"
    },
    "SellSitd": "false",
    "SellTrust": ""
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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