Querying Details About a KMS Key

Function

This API is used to query details about a KMS key. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

Constraints

The instance version must be V2.0-3.300 or later.

URI

GET /v3/{project_id}/kms/{kms_key_id}/describe-key/{kms_project_name}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
kms_key_id	Yes	String	Definition KMS key ID. Constraints N/A Range N/A Default Value N/A
kms_project_name	Yes	String	Definition Name of a resource space, where you can view the ID of the KMS master key used by GaussDB for transparent data encryption. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
key_id	String	Definition Key ID. Range N/A
key_alias	String	Definition Key alias. Range N/A
domain_id	String	Definition User domain ID. Range N/A
key_state	String	Definition Key status. Range 1: to be activated 2: enabled 3: disabled 4: pending deletion 5: pending import

Example Request

Querying details about a specified KMS key

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/4f07d3f50ce2466a9a7c014337b36409/kms/be987847-bebf-42e9-9a1f-1ec1254cc213/describe-key/cn-southwest-244

Example Response

{ 
  "key_id" : "48891736-c787-4f17-8f6c-9e227e9ca4c7", 
  "key_alias" : "KMS-gaussdb-te", 
  "domain_id" : "5cf7b58fe8f14bacaa1abe2ec01feb5f", 
  "key_state" : "2" 
}