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/7.0 instances.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A
instance_id	Yes	String	Definition: Instance ID. It can be viewed on the instance details page on the DCS console. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
enabled	Boolean	Definition: This parameter is returned only when SSL is enabled for the instance. Range: true: SSL is enabled.
ip	String	Definition: IPv4 address used when SSL is enabled. Range: N/A
ipv6	String	Definition: IPv6 address used when SSL is enabled. Range: N/A
port	String	Definition: Port used when SSL is enabled. Range: N/A
domain_name	String	Definition: Domain name used when SSL is enabled. Range: N/A
ssl_expired_at	String	Definition: SSL certificate validity period (UTC time). Range: N/A
ssl_validated	Boolean	Definition: Whether the SSL certificate is valid. Range: true: Yes false: No

Status code: 204

Definition:

No SSL info.

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

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

Example Responses

Status code: 200

Definition:

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

Definition:

Invalid request.

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

Status code: 500

Definition:

Internal service error.

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

Status Codes

Status Code	Description
200	Definition: Instance SSL queried successfully.
204	Definition: No SSL info.
400	Definition: Invalid request.
500	Definition: Internal service error.