tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSSLStatus

Last updated: 2024-04-03 11:33:15

    1. API Description

    Domain name for API request: redis.tencentcloudapi.com.

    This API is used to query the SSL authentication information of an instance, such as enablement status, configuration status, and certificate address.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeSSLStatus.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID

    3. Output Parameters

    Parameter Name Type Description
    CertDownloadUrl String Download address for SSL certificate
    UrlExpiredTime String Expiration time of the certificate download address
    SSLConfig Boolean Whether the SSL is enabled for the identified instance.
    - true: Enabled
    - false: Disabled
    FeatureSupport Boolean Whether SSL is supported for the identified instance.
    -true: Supported
    -false: Not supported
    Status Integer Status of SSL configuration
    - 1: Configuring
    - 2: Configured successfully
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Example 1

    This example shows you how to query the SSL authentication information of an instance.

    Input Example

    https://redis.tencentcloudapi.com/?Action=DescribeSSLStatus
&InstanceId=crs-2btr9ryn
&<Common request parameters>

    Output Example

    {
    "Response": {
        "CertDownloadUrl": "abc",
        "UrlExpiredTime": "abc",
        "SSLConfig": true,
        "FeatureSupport": true,
        "Status": 0,
        "RequestId": "abc"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.SystemError Internal system error, which is irrelevant to the business.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameter.ActionNotFound The corresponding API was not found.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    InvalidParameterValue.UnSupportedType The instance type is not supported.
    ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
    ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy