Help Center/ Distributed Cache Service/ API Reference (Ally Region)/ APIs V2 (Recommended)/ Network Security/ Downloading the SSL Certificate of an Instance
Updated on 2025-12-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Downloading the SSL Certificate of an Instance

Function

This API is used to download the SSL certificate of an instance. This API is only supported by DCS Redis 6.0/7.0 instances.

URI

POST /v2/{project_id}/instances/{instance_id}/ssl-certs/download

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

file_name

String

SSL certificate file name.

link

String

Download link of the SSL certificate.

bucket_name

String

Name of the OBS bucket for storing the SSL certificate.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_msg

String

Definition:

Error message.

Range:

N/A

error_code

String

Definition:

Error code.

Range:

For details, see Error Codes.

error_ext_msg

String

Definition:

Extended error information. This parameter is not used currently and is set to null.

Range:

N/A

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Definition:

Error message.

Range:

N/A

error_code

String

Definition:

Error code.

Range:

For details, see Error Codes.

error_ext_msg

String

Definition:

Extended error information. This parameter is not used currently and is set to null.

Range:

N/A

Example Requests

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/ssl-certs/download

Example Responses

Status code: 200

SSL certificate of the instance downloaded.

{
  "bucket_name" : "bucket_name",
  "file_name" : "file_name",
  "link" : "https://{bucket_name}.{obs_endpoint}:443/{ssl-XXX}/{file_name}?AWSAccessKeyId=XXX&Expires=XXX&Signature=XXX"
}

Status code: 400

Invalid request.

{
  "error_code" : "DCS.4201",
  "error_msg" : "Do not support SSL."
}

Status code: 500

Internal service error.

{
  "error_code" : "DCS.5010",
  "error_msg" : "Failed to operate SSL in database."
}

Status Codes

Status Code

Description

200

SSL certificate of the instance downloaded.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Network Security