Querying Cluster Encryption Information

Function

This API is used to query the encryption information of cluster. Non-encryption clusters do not support this function, so the returned information is empty.

Constraints

To convert an encryption cluster, the ordinary cluster version must be 8.0.0 or later.

To convert an encryption cluster, the guestAgent version must be 8.3.0.200 or later.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/encrypt-info

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. 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
id	String	Definition Encryption ID, which is used only internally by GaussDB(DWS). Range N/A
cluster_id	String	Definition Cluster ID. Range N/A
master_key_id	String	Definition KMS key ID. Range N/A
master_key_name	String	Definition KMS key name. Range N/A
last_rotate_key_time	String	Definition Time when the last key rotation was performed. Range N/A
crypt_algorithm	String	Definition Encryption mode. Range N/A

Example Requests

Query the cluster encryption information.

GET https://{endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/97cbaab3-939e-4dbc-9187-0fe240f2b9fd/encrypt-info

Example Responses

Status code: 200

Request submitted.

{
  "id" : null,
  "cluster_id" : null,
  "master_key_id" : null,
  "master_key_name" : null,
  "last_rotate_key_time" : null,
  "crypt_algorithm" : null
}

Status Codes

Status Code	Description
200	Request submitted.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.