DescribeDBInstanceNetInfo操作を呼び出して、ApsaraDB RDSインスタンスのエンドポイントを照会できます。

デバッグ

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

リクエストパラメーター

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

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

ClientToken String 任意 ETnLKlblzczshOTUbOC *****

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、生成されたトークンが異なるリクエスト間で一意であることを確認する必要があります。 トークンにはASCII文字のみを使用でき、長さは64文字を超えることはできません。

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

インスタンスの ID です。

フラグ Integer いいえ N/A

予約済みのパラメーター。

DBInstanceNetRWSplitType String 任意 ノーマル

エンドポイントのタイプ。 有効な値：

  • Normal: 通常のエンドポイント
  • ReadWriteSplitting: 読み書き分離エンドポイント
説明 デフォルトでは、システムは両方のタイプのエンドポイントを返します。
GeneralGroupName String 任意 rgc-2ze *****

インスタンスが属する専用クラスターの名前。 このパラメーターは、インスタンスがRDS Standard EditionでMySQLを実行し、専用クラスターで作成された場合にのみ有効になります。

レスポンスパラメーター

項目 データ型 例: 説明　
SecurityIPMode String 安全性

インスタンスのホワイトリストモード。 有効な値：

  • normal: 標準ホワイトリストモード
  • safety: 強化されたホワイトリストモード
RequestId String 777C4593-8053-427B-99E2-105593277CAB

リクエストの ID です。

InstanceNetworkType String VPC

インスタンスのネットワークタイプです。 有効な値：

  • クラシック
  • [VPC]
DBInstanceNetInfos DBInstanceNetInfoの配列

インスタンスのエンドポイントの詳細。

DBInstanceNetInfo
VSwitchId String vsw-uf6adz52c2p *****

VSwitch の ID です。

ConnectionStringType String ノーマル

エンドポイントのタイプ。 有効な値：

  • Normal: 通常のエンドポイント
  • ReadWriteSplitting: 読み書き分離エンドポイント
ConnectionString String rm-uf6w ***** .mysql.rds.aliyuncs.com

インスタンスのエンドポイント。

ExpiredTime String 1209534

ハイブリッドアクセスモードでのクラシックネットワークのインスタンスの残りの有効期間。 単位：秒。

アップグレード可能 String 無効

IPバージョンを更新できるかどうかを示します。 有効な値：

  • 有効: IPバージョンを更新できます。
  • 無効: IPバージョンを更新できません。
    説明 IPバージョンはIPv4からIPv6に更新できます。
MaxDelayTime String 12

レイテンシしきい値。 このパラメーターは、読み書き分離エンドポイントに対してのみ返されます。 単位：秒。

説明 読み取り専用インスタンスのレイテンシが指定されたしきい値を超えると、ApsaraDB RDSは読み取り要求を読み取り専用インスタンスに転送しなくなります。
IPType String パブリック

ネットワークタイプ。

  • インスタンスがクラシックネットワークに存在する場合の有効値:
    • Inner:: 内部ネットワーク
    • パブリック: インターネット
  • インスタンスが仮想プライベートクラウド (VPC) にある場合の有効値:
    • Private: 内部ネットワーク
    • パブリック: インターネット
ポート String 3306

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

BabelfishPort String 1433

Babelfishが有効になっているインスタンスのTabular Data Stream (TDS) ポート。

説明 このパラメーターは、ApsaraDB RDS for PostgreSQLインスタンスにのみ適用されます。 Babelfish For ApsaraDB RDS for PostgreSQLの詳細については、「Babelfishの紹介」をご参照ください。
VPCId String vpc-uf6f7l4fg90 *****

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

DistributionType String スタンダード

読み取り重みの割り当てに使用されるポリシー。 このパラメーターは、読み書き分離エンドポイントに対してのみ返されます。 有効な値：

  • 標準: ApsaraDB RDSは、インスタンスの仕様に基づいて、インスタンスとその読み取り専用インスタンスに読み取り重みを自動的に割り当てます。
  • カスタム: インスタンスとその読み取り専用インスタンスに読み取り重みを手動で割り当てる必要があります。
IPAddress String 192.168.XX.XX

インスタンスの IP アドレス。

SecurityIPGroups securityIPGroupの配列

インスタンスのIPホワイトリストの詳細。

securityIPGroup
セキュリティIP String 127.0.XX.XX

IPアドレスホワイトリストに含まれるIPアドレス。

SecurityIPGroupName String デフォルト

IP アドレスホワイトリストの名前。

DBInstanceWeights DBInstanceWeightの配列

重量の詳細。 このパラメーターは、インスタンスに対して読み書き分離機能が有効になっている場合にのみ返されます。

DBInstanceWeight
Availability String 使用できません

インスタンスの可用性。 有効な値：

  • 利用不可
  • 利用可能
重量 String 100

インスタンスの重み。

DBInstanceId String rm-uf6wjk5 *****

インスタンスの ID です。

Role String N/A

非推奨のパラメーター。

DBInstanceType String マスター

インスタンスのロール。 有効な値：

  • マスター: プライマリインスタンス
  • Readonly: 読み取り専用インスタンス

例

リクエストの例

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

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

XML 形式

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

<DescribeDBInstanceNetInfoResponse>
    <dBInstanceNetInfos>
        <connectionString>rm-uf6wjk5 ***** .mysql.rds.aliyuncs.com</connectionString>
        <connectionStringType> 通常 </connectionStringType>
        <iPAddress>192.168.XX.XX</iPAddress>
        <iPType> パブリック </iPType>
        <port>3306</port>
        <upgradeable> 無効 </upgradeable>
        <vPCId/>
    </dBInstanceNetInfos>
    <instanceNetworkType> クラシック </instanceNetworkType>
    <requestId>777C4593-8053-427B-99E2-105593277CAB</requestId>
</DescribeDBInstanceNetInfoResponse>

JSON 形式

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

{
  "dBInstanceNetInfos" : {
    "connectionString" : "rm-uf6wjk5 ***** .mysql.rds.aliyuncs.com" 、
    "connectionStringType" : "Normal" 、
    "iPAddress" : "192.168.XX.XX" 、
    "iPType" : "パブリック" 、
    "port" : 3306、
    "upgradeable" : "Disabled" 、
    "vPCId" : ""
  },
  "instanceNetworkType" : "クラシック" 、
  "requestId" : "777C4593-8053-427B-99E2-105593277CAB"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 IllegalParameter 不正なパラメータ 指定されたパラメーターが無効な場合に返されるエラーメッセージ。

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