GetDBInstanceTopology操作を呼び出して、インスタンスのトポロジを取得できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 GetDBInstanceTopology

実行する操作です。 値をGetDBInstanceTopologyに設定します。

DBInstanceId String 必須 rm-uf6wjk5 *******

インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。

レスポンスパラメーター

項目 データ型 例: 説明　
Code String なし

内部パラメーター。 このパラメーターは無視できます。

Message String なし

内部パラメーター。 このパラメーターは無視できます。

RequestId String 7430AB1A-6D49-5B6D-B9E5-920250076074

リクエストの ID です。

データ オブジェクト

トポロジに関する詳細。

DBInstanceName String rm-m5ezban **********

インスタンスの ID です。

接続 接続の配列

インスタンスのネットワーク接続。

ZoneId String cn-qingdao-c

ゾーン ID。

DBInstanceName String rm-m5ezban **********

インスタンスの ID です。

ConnectionString String rm-m5ezban ********** .mysql.rds.aliyuncs.com

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

NetType String vpc

エンドポイントのネットワークタイプ。 有効な値：

  • vpc
  • パブリック
ノード ノードの配列

ノード情報。

DBInstanceName String rm-m5ezban **********

インスタンスの ID です。

ZoneId String cn-qingdao-c

ゾーン ID。

DedicatedHostId String i-bpxxxxxxx

専用クラスター内のインスタンスが存在するホストのID。

説明 インスタンスが専用クラスターに存在しない場合、値は返されません。
Role String master

ノードの種類。 有効な値：

  • マスター: プライマリノード
  • スレーブ: セカンダリノード
NodeId String 349054

インスタンスの ID です。

説明 専用クラスターに存在しないインスタンスの場合、値 -1が返されます。
DedicatedHostGroupId String dhg-4n *****

専用クラスターのID。

説明 インスタンスが指定された専用クラスターに存在しない場合、値は返されません。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=GetDBInstanceTopology
&DBInstanceId=rm-uf6wjk5 *******
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetDBInstanceTopologyResponse>
    <RequestId>CF5A551A-80EF-1D3D-8F43-6B52C1E2EF71</RequestId>
    <Data>
    </データ>
</GetDBInstanceTopologyResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CF5A551A-80EF-1D3D-8F43-6B52C1E2EF71" 、
  "Data" : {
    "接続" : [ ],
    "ノード" : [ ]
  }
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 InvalidAction 指定されたアクションは無効です。 操作がサポートされていない場合に返されるエラーメッセージ。
403 DBInstanceStatusNotActive 現在のインスタンスのステータスがアクティブではありません。 インスタンスのステータスが操作をサポートしていない場合に返されるエラーメッセージ。
403 DBTypeNotSupported データベースタイプはサポートされていません。 データベースタイプがサポートされていない場合に返されるエラーメッセージ。
404 InvalidDBInstance.NotFound 指定されたインスタンスが存在しないか、サポートされていません。 指定されたインスタンスが見つからない場合に返されるエラーメッセージ。 インスタンスのIDを確認します。

エラーコードリストについては、「API エラーセンター」をご参照ください。