すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeInstanceSSL

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeInstanceSSL

    最終更新日:Mar 30, 2026

    Tair (Redis OSS-compatible) インスタンスで TLS (SSL) 暗号化が有効になっているかどうかを照会します。

    操作説明

    SSL 暗号化は、Tair (Redis OSS-compatible) 2.8 標準マスターレプリカインスタンス、Tair (Redis OSS-compatible) 2.8 マスターレプリカクラスターインスタンス、および Tair (Redis OSS-compatible) 4.0 マスターレプリカクラスターインスタンスでサポートされています。SSL 暗号化を有効にすることで、データ転送のセキュリティを強化できます。

    次のいずれかの方法で、Tair (Redis OSS-compatible) インスタンスの SSL 暗号化を有効または無効にするか、SSL 証明書を更新できます。

    • ModifyInstanceSSL 操作を呼び出します。

    • Tair (Redis OSS-compatible) コンソールで SSL 暗号化を有効または無効にするか、SSL 証明書を更新します。詳細については、「SSL 暗号化の設定」をご参照ください。

    説明

    SSL 暗号化を有効にすると、インスタンスの応答が遅くなる場合があります。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    kvstore:DescribeInstanceSSL

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンスの ID。

    r-bp1zxszhcgatnx****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    InstanceId

    string

    インスタンスの ID。

    r-bp1zxszhcgatnx****
    RequestId

    string

    リクエストの ID。

    02260F96-913E-4655-9BA5-A3651CAF****
    SSLEnabled

    string

    TLS (SSL) 暗号化機能のステータス。有効な値：

    • Enable：SSL 暗号化が有効になっています。

    • Disable：SSL 暗号化が無効になっています。

    Enable
    SSLExpiredTime

    string

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

    2020-08-05T09:05:53Z
    CertCommonName

    string

    CA 証明書の共通名。デフォルト値はインスタンスの内部エンドポイントです。

    r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
    CertDownloadURL

    string

    CA 証明書のダウンロード URL。

    https://apsaradb-public.oss-ap-sout****-1.aliy****.com/ApsaraDB-CA-Chain.zip

    例

    成功レスポンス

    JSONJSON

    {
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "02260F96-913E-4655-9BA5-A3651CAF****",
  "SSLEnabled": "Enable",
  "SSLExpiredTime": "2020-08-05T09:05:53Z",
  "CertCommonName": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
  "CertDownloadURL": "https://apsaradb-public.oss-ap-sout****-1.aliy****.com/ApsaraDB-CA-Chain.zip"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidRedisVersionPattern Redis db or proxy version does not match specified pattern.
    403 IncorrectCharacterType Current DB instance CharacterType does not support this operation.
    403 IncorrectEngineVersion Current engine version does not support operations.
    404 InvalidInstanceId.NotFound The InstanceId provided does not exist in our records.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。