SwitchDBInstanceNetType API の呼び出し - クラシックネットワークで内部とパブリックエンドポイントを切り替え - RDS

エンドポイントリソースを節約するには、このAPIを呼び出して、内部エンドポイントとパブリックエンドポイントの間でインスタンスを切り替えることができます。インスタンスへの接続に使用されるエンドポイントが変更された後、アプリケーションのコード内のエンドポイント情報を更新し、アプリケーションを再起動する必要があります。

この API を呼び出す場合、インスタンスは次の要件を満たしている必要があります。

インスタンスは、内部エンドポイントまたはパブリックエンドポイントを使用して接続されます。
インスタンスのステータスは [実行中] です。
過去24時間以内にインスタンスを内部エンドポイントとパブリックエンドポイント間で切り替えた回数は20回に達しません。
インスタンスはクラシックネットワークに存在します。

デバッグ

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

リクエストパラメーター

項目	データ型	必須／任意	例:	説明
操作	String	必須	SwitchDBInstanceNetType	実行する操作です。値をSwitchDBInstanceNetTypeに設定します。
ClientToken	String	任意	ETnLKlblzczshOTUbOCzxxxxxx	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意である必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
DBInstanceId	String	必須	rm-bp1 **************	インスタンスの ID です。
ConnectionStringPrefix	String	必須	新しい **********	カスタムエンドポイントのプレフィックス。プレフィックスの長さは8 ~ 64文字で、英数字を使用できます。小文字で始める必要があります。有効なエンドポイントは次の形式です。Prefix.Databas e engine.rds.aliyuncs.com。例: test1234.mysql.rds.aliyuncs.com。
ポート	String	任意	3306	エンドポイントに関連付けられているポート。有効値: 3001〜3999
ConnectionStringType	String	任意	ノーマル	エンドポイントのタイプ。有効な値：通常 ReadWriteSplitting デフォルトでは、システムは両方のタイプのエンドポイントを返します。

レスポンスパラメーター

項目	データ型	例:	説明
NewConnectionString	String	新しい ********** .mysql.rds.aliyuncs.com	エンドポイントの切り替え後にインスタンスに接続するために使用されるエンドポイント。
RequestId	String	65BDA532-28AF-4122-AA39-B382721EEE64	リクエストの ID です。
OldConnectionString	String	rm-bp1 **************** .mysql.rds.aliyuncs.com	エンドポイントの切り替え前にインスタンスに接続するために使用されるエンドポイント。

例

リクエストの例

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

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

XML 形式

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

<SwitchDBInstanceNetTypeResponse>
    <RequestId>94D5FC3C-1314-5883-9127-61D2105515AF</RequestId>
    <OldConnectionString>rm-bp1qp11x5 *************** .rds.aliyuncs.com</OldConnectionString>
    <NewConnectionString> 新しい *********** .rds.aliyuncs.com</NewConnectionString>
</SwitchDBInstanceNetTypeResponse>

JSON 形式

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

{
  "RequestId" : "94D5FC3C-1314-5883-9127-61D2105515AF" 、
  "OldConnectionString" : "rm-bp1qp11x5 **************** .rds.aliyuncs.com" 、
  "NewConnectionString" : "new ********** .rds.aliyuncs.com"
}

エラーコード

エラーコードのリストについては、エラーセンターをご覧ください。