All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeInstanceSSL

    Document Center

    Tair (Redis® OSS-Compatible):DescribeInstanceSSL

    Last Updated:Aug 28, 2026

    Queries whether TLS (SSL) encryption is enabled for a Tair (Redis OSS-compatible) instance.

    Operation description

    SSL encryption is supported for Tair (Redis OSS-compatible) 2.8 standard master-replica instances, Tair (Redis OSS-compatible) 2.8 master-replica cluster instances, and Tair (Redis OSS-compatible) 4.0 master-replica cluster instances. You can enable SSL encryption to enhance data transmission security.

    You can use one of the following methods to enable or disable SSL encryption or update the SSL certificate for a Tair (Redis OSS-compatible) instance:

    Note

    After SSL encryption is enabled, the instance may respond slower.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    kvstore:DescribeInstanceSSL

    get

    *DBInstance

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the instance.

    r-bp1zxszhcgatnx****

    Response elements

    Element

    Type

    Description

    Example

    object

    InstanceId

    string

    The ID of the instance.

    r-bp1zxszhcgatnx****
    RequestId

    string

    The ID of the request.

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

    string

    The status of the TLS (SSL) encryption feature. Valid values:

    • Enable: SSL encryption is enabled.

    • Disable: SSL encryption is disabled.

    Enable
    SSLExpiredTime

    string

    The time when the CA certificate expires.

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

    string

    The common name of the CA certificate. The default value is the internal endpoint of the instance.

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

    string

    The download URL of the CA certificate.

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

    Examples

    Success response

    JSON format

    {
  "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"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.