Querying KMS Keys

Function

This API is used to query keys. 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/list-keys/{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_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_details	Array of objects	Definition KMS key details. See Table 4.
authorized_id	String	Definition Authorized user ID. This must be set for the current user when enabling transparent data encryption. For details, see the API Creating a Grant. Range N/A
authorized_name	String	Definition Authorized username. Range N/A

**Table 4** key_details
Parameter	Type	Description
key_id	String	Definition Key ID. Range N/A
default_key_flag	String	Definition Default master key flag. Range 1 for the default master key, and 0 for the non-default master key.
key_alias	String	Definition Key alias. Range N/A
key_spec	String	Definition Key generation algorithm. Range AES_256 SM4 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 ALL
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 available KMS keys

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/4f07d3f50ce2466a9a7c014337b36409/kms/list-keys/cn-southwest-244

Example Response

{
	"key_details": [
		{
			"key_id": "1df79795-a726-460a-baed-2585309b7566",
			"default_key_flag": "0",
			"key_alias": "KMS-hwx627992",
			"key_spec": "AES_256",
			"domain_id": "0611e0475e00d5d10fabc017d8af04a0",
			"key_state": "2"
		}
	],
	"authorized_id": "6a4ace47839542ff8415207697574a60",
	"authorized_name": "default_kms_user"
}