DescribeDBInstanceSSL操作を呼び出して、ApsaraDB RDSインスタンスのSSL暗号化設定を照会できます。

この操作を呼び出す前に、インスタンスが次のいずれかのインスタンスであることを確認してください。

  • RDS Basic Editionを実行しないApsaraDB RDS for MySQLインスタンス
  • ApsaraDB RDS for SQL Serverインスタンス
  • 標準SSDまたは拡張SSD (ESSD) を使用するApsaraDB RDS for PostgreSQLインスタンス

デバッグ

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

リクエストパラメーター

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

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

DBInstanceIdString必須rm-bp162dfr55g47 ****

インスタンスの ID です。

レスポンスパラメーター

項目データ型例:説明
ServerCertString----- CERTIFICATE-----MIIDを開始 ***** 証明書EP-----END Qq ----

サーバー証明書の内容。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。

ClientCACertExpireTimeString-

クライアント証明書を発行するCAの公開鍵の有効期限が切れる時刻。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。 このパラメーターは現在サポートされていません。

RequireUpdateItemString-

更新が必要なサーバー証明書。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。

ServerCAUrlString-

サーバー証明書の発行に使用される証明書のURL。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。

RequireUpdateString必須

サーバー証明書を更新する必要があるかどうかを示します。

  • ApsaraDB RDS for MySQLインスタンスおよびApsaraDB RDS for SQL Serverインスタンスの有効な値:
    • いいえ
    • はい
  • ApsaraDB RDS for PostgreSQLインスタンスの有効な値:
    • 0: なし
    • 1: はい
ClientCertRevocationListString----- 開始X509 CRL-----MIIB **** 19mg==----- END X509 CRL ----

失効したクライアント証明書を含む証明書失効リスト (CRL) 。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。

SSLExpireTimeString2022-10-11T08:16:43Z

サーバー証明書の有効期限。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

CATypeStringaliyun

サーバー証明書のタイプ。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 有効な値：

  • aliyun: クラウド証明書
  • custom: カスタム証明書
SSLCreateTimeString-

サーバー証明書が作成された時刻。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 また、このパラメーターは、CATypeパラメーターがaliyunに設定されている場合にのみ有効です。

複製ACLStringcert

レプリケーション権限の検証に使用されるメソッド。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 有効な値：

  • cert
  • パーファー
  • verify-ca
  • verify-full (インスタンスがPostgreSQL 12以降を実行している場合のみサポート)
ACLStringcert

クライアントのIDを検証するために使用されるメソッド。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 有効な値：

  • cert
  • パーファー
  • verify-ca
  • verify-full (インスタンスがPostgreSQL 12以降を実行している場合のみサポート)
RequestIdString7705151C-E242-55AF-9929-2A3C39D979D2

リクエストの ID です。

LastModifyStatusString設定

SSLリンクのステータス。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 有効な値：

  • 成功
  • 設定
  • 失敗しました
SSLEnabledString必須

SSL 暗号化が有効かどうかを示します。

  • ApsaraDB RDS for MySQLインスタンスおよびApsaraDB RDS for SQL Serverインスタンスの有効な値:
    • はい: 有効
    • No: 無効
  • ApsaraDB RDS for PostgreSQLインスタンスの有効な値:
    • on: enabled
    • off: 無効
ConnectionStringStringrm-bp162dfr55g47 **** .mysql.rds.aliyuncs.com

SSL暗号化によって保護されているエンドポイント。

RequireUpdateReasonString-

サーバー証明書を更新する必要がある理由。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。

ClientCACertString----- CERTIFICATE-----MIIDを開始 ***** viXk=----- 証明書を終了 -----

クライアント証明書を発行するCAの公開鍵。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。

ServerKeyString----- プライベートKEY-----MIIEを開始 **** ihfg==----- プライベートキーを終了 -----

サーバー証明書の秘密鍵。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。

ModifyStatusReasonStringDBインスタンスSSL設定を変更します。

SSLリンクが現在の状態にとどまる理由。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。

例

リクエストの例

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

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

XML 形式

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

<DescribeDBInstanceSSL>
    <RequestId>7705151C-E242-55AF-9929-2A3C39D979D2</RequestId>
    <RequireUpdate> はい </RequireUpdate>
    <SSLExpireTime>2022-10-11T08:16:43Z</SSLExpireTime>
    <SSLEnabled> はい </SSLEnabled>
    <RequireUpdateReason/>
    <ConnectionString>rm-bp162dfr55g47 **** .mysql.rds.aliyuncs.com</ConnectionString>
</DescribeDBInstanceSSL>

JSON 形式

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

{
  "RequestId" : "7705151C-E242-55AF-9929-2A3C39D979D2" 、
  "RequireUpdate" : "はい" 、
  "SSLExpireTime" : "2022-10-11T08:16:43Z" 、
  "SSLEnabled" : "はい" 、
  "RequireUpdateReason" : "" 、
  "ConnectionString" : "rm-bp162dfr55g47 **** .mysql.rds.aliyuncs.com"
}

エラーコード

HTTP ステータスコードエラーコードエラーメッセージ説明
400InvaildEngineInRegion.ValueNotSupportedこの地域ではエンジンはサポートされていません。インスタンスで実行されるデータベースエンジンが指定されたリージョンでサポートされていない場合に返されるエラーメッセージ。
403OperationDenied.DBInstanceTypeインスタンスのタイプが原因で操作が許可されていません。操作がインスタンスのロールでサポートされていない場合に返されるエラーメッセージ。 インスタンスが読み取り専用インスタンスであるかどうかを確認する必要があります。 読み取り専用インスタンスは複製できません。
403InstanceEngineType.NotSupportインスタンスエンジンとタイプは操作をサポートしていません指定されたデータベースエンジンとインスタンスタイプで操作がサポートされていない場合に返されるエラーメッセージ。
403IncorrectEngineVersion現在のエンジンバージョンは操作をサポートしていません。インスタンスで実行されているデータベースエンジンバージョンでは、この操作がサポートされていない場合に返されるエラーメッセージ。
403IncorrectDBInstanceState現在のDBインスタンスの状態は、この操作をサポートしていません。インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
403IncorrectDBInstanceType現在のDBインスタンスタイプは、この操作をサポートしていません。インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
403IncorrectDBInstanceLockMode現在のDBインスタンスロックモードはこの操作に対応していません。インスタンスがロックされている場合に返されるエラーメッセージ。
403ConnectionStringLengthExceeded接続文字列が長すぎます。指定されたエンドポイントの長さが上限を超えた場合に返されるエラーメッセージ。 有効なエンドポイントを入力する必要があります。
404InvalidDBInstanceId.NotFound指定されたインスタンスが見つかりません。インスタンスが存在しない場合に返されるエラーメッセージ。 現在のアカウントにインスタンスが存在するかどうかを確認する必要があります。
404EnabledSSLNotSupport指定されたリージョンは有効sslをサポートしていません。指定されたリージョンでSSL暗号化機能がサポートされていない場合に返されるエラーメッセージ。
404InvalidConnectionString.NotFound指定された接続文字列またはネットタイプが見つかりません。指定したエンドポイントが見つからない場合に返されるエラーメッセージ。 指定されたエンドポイントが有効かどうかを確認する必要があります。

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