Help Center/ Distributed Cache Service/ API Reference/ API V2/ Network Security/ Querying SSL Encryption of an Instance
Updated on 2025-05-13 GMT+08:00
View PDF

Querying SSL Encryption of an Instance

Function

This API is used to query SSL encryption of an instance. This API is only supported by DCS Redis 6.0 instances.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/ssl

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

enabled

Boolean

This parameter is returned with true only when SSL is enabled for the instance.

ip

String

IPv4 address used when SSL is enabled.

ipv6

String

IPv6 address used when SSL is enabled.

port

String

Port used when SSL is enabled.

domain_name

String

Domain name used when SSL is enabled.

ssl_expired_at

String

SSL certificate validity period (UTC time).

ssl_validated

Boolean

Whether the SSL certificate is valid.

Status code: 204

No SSL info.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

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

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

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

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/ssl

Example Responses

Status code: 200

Instance SSL queried successfully.

{
  "enabled" : true,
  "ip" : "192.168.0.5",
  "ipv6" : "::1",
  "port" : "6379",
  "domain_name" : "redis-553a2516-b865-4159-b774-204dc0a36e37.dcs.example.com:6379",
  "ssl_expired_at" : "2022-06-15T02:21:18.669Z",
  "ssl_validated" : true
}

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

Instance SSL queried successfully.

204

No SSL info.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Network Security