GetDbProxyInstanceSsl操作を呼び出して、ApsaraDB RDSインスタンスの専用プロキシエンドポイントのSSL暗号化設定を照会できます。

ApsaraDB RDSは専用プロキシ機能を提供します。 インスタンスの専用プロキシエンドポイントにSSL暗号化を設定できます。 これにより、インスタンスのデータセキュリティを確保できます。 専用プロキシ機能の詳細については、「専用プロキシ」をご参照ください。

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

  • インスタンスに対して専用プロキシ機能を有効にする必要があります。
  • インスタンスの専用プロキシが実行するマイナーエンジンのバージョンは、1.12.8以降である必要があります。
  • インスタンスのマイナーエンジンバージョンは20200831以降である必要があり、インスタンスは次のMySQLバージョンとRDSエディションを実行する必要があります。
    • ローカルSSDを使用したRDS High-availability EditionのMySQL 8.0
    • ローカルSSDを使用したRDS High-availability EditionのMySQL 5.7
    • ローカルSSDを使用したRDS High-availability EditionのMySQL 5.6

デバッグ

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

リクエストパラメーター

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

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

RegionId String 任意 cn-hangzhou

インスタンスのリージョン ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

DbInstanceId String 必須 rm-t4n3axxxxx

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

DBProxyEngineType String 任意 normal

内部パラメーター。 指定する必要はありません。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String D330E60C-8AAA-4D63-8F64-5B78F4692F98

リクエストの ID です。

DbProxyCertListItems DbProxyCertListItemsの配列

SSL暗号化設定で構成される配列。

DbProxyCertListItems
DbInstanceName String rm-t4n3axxxxx

インスタンスの ID です。

EndpointName String buxxxxxxx

専用プロキシエンドポイントのID。

EndpointType String RWSplit

専用プロキシエンドポイントのデフォルト識別子。 値はRWSplitとして固定されています。

SslExpiredTime String 2021-12-16T08:43:20Z

証明書の有効期限が切れる時刻。

CertCommonName String test1234.rwlb.rds.aliyuncs.com

SSL暗号化が有効になっている専用プロキシエンドポイント。

例

リクエストの例

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

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

XML 形式

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

<GetDbProxyInstanceSslResponse>
<RequestId>D330E60C-8AAA-4D63-8F64-5B78F4692F98</RequestId>
<DbProxyCertListItems>
    <DbProxyCertListItems>
        <EndpointName>buxxxxxxx</EndpointName>
        <EndpointType>RWSplit</EndpointType>
        <CertCommonNam e>test1234.rwlb.rds.aliyuncs.com</CertCommonName>
        <SslExpiredTime>2021-12-16T08:43:20Z</SslExpiredTime>
        <DbInstanceName>rm-t4n3axxxxx</DbInstanceName>
    </DbProxyCertListItems>
</DbProxyCertListItems>
</GetDbProxyInstanceSslResponse>

JSON 形式

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

{
  "RequestId" : "D330E60C-8AAA-4D63-8F64-5B78F4692F98" 、
  "DbProxyCertListItems" : {
    "DbProxyCertListItems" : [ {
      "EndpointName" : "buxxxxxxx" 、
      "EndpointType" : "RWSplit" 、
      "CertCommonName" : "test1234.rwlb.rds.aliyuncs.com" 、
      "SslExpiredTime" : "2021-12-16T08:43:20Z" 、
      "DbInstanceName" : "rm-t4n3axxxxx"
    } ]
  }
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 InvalidVpcInstanceId 指定されたVPCインスタンスIDは無効です。 指定されたVPC IDが無効な場合に返されるエラーメッセージ。
400 InvalidDBInstanceName 指定されたパラメーターDBInstanceNameは無効です。 DBInstanceNameパラメーターの値が無効な場合に返されるエラーメッセージ。 値がnullまたは空の文字列であるかどうかを確認します。
403 IncorrectDBInstanceType 現在のデータベースインスタンスタイプは、この操作をサポートしていません。 インスタンスの設定がこの操作をサポートしていない場合に返されるエラーメッセージ。
404 InvalidDBInstance.NotFound 指定されたインスタンスが存在しないか、サポートされていません。 指定されたインスタンスが見つからない場合に返されるエラーメッセージ。 インスタンスのIDを確認します。
404 Endpoint.NotFound 指定されたエンドポイントが見つかりません。 指定されたエンドポイントが見つからない場合に返されるエラーメッセージ。

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