AllocateInstancePublicConnection操作を呼び出して、ApsaraDB RDSインスタンスのパブリックエンドポイントを申請できます。

デバッグ

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

リクエストパラメーター

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

実行する操作の API 値をAllocateInstancePublicConnectionに設定します。

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

インスタンスの ID です。

ConnectionStringPrefix String 必須 test1234

パブリックエンドポイントのプレフィックスです。 有効なパブリックエンドポイントは、次の形式です。Prefix.Databas e engine.rds.aliyuncs.com。 例: test1234.mysql.rds.aliyuncs.com。

説明 値の長さは5 ~ 40文字で、英数字、ハイフン (-) を使用できます。 値に次の文字を含めることはできません。~! # % ^ & * = + | {} ; : '" , <> / ?
ポート String 必須 3306

インスタンスのパブリックポート。 有効値: 1000〜5999

BabelfishPort String 任意 1433

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

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

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

レスポンスパラメーター

項目 データ型 例: 説明　
DbInstanceName String rm-bp1 *****

インスタンスの ID です。

RequestId String 65BDA532-28AF-4122-AA39-B382721EEE64

リクエストの ID です。

ConnectionString String テスト ***** .mysql.rds.aliyuncs.com

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

例

リクエストの例

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

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

XML 形式

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

<AllocateInstancePublicConnectionResponse>
    <DbInstanceName>rm-bp1 *****</DbInstanceName>
    <RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>
    <ConnectionString>test ***** .mysql.rds.aliyuncs.com</ConnectionString>
</AllocateInstancePublicConnectionResponse>

JSON 形式

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

{
  "DbInstanceName" : "rm-bp1 *****" 、
  "RequestId" : "65BDA532-28AF-4122-AA39-B382721EEE64" 、
  "ConnectionString" : "test ***** .mysql.rds.aliyuncs.com"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 OtherEndpoint. 存在する 他のエンドポイントが存在します。 指定されたパブリックエンドポイントのプレフィックスが既に存在する場合に返されるエラーメッセージ。

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