project_id

Yes

String

Project ID.

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

limit

No

String

Number of records in a query. If action is to count, you do not need to set this parameter. If action is filter, the default value of this parameter is 10. The value of limit is in the ranges 1 to 1,000.

offset

No

String

Index location. The query starts from the next resource of the specified location. When data on a page is queried, the value in the response body of the previous page is transferred to this parameter. (If action is to count, you do not need to set this parameter.) If the action value is filter, the default value is 0. The value of offset must be a number and cannot be negative.

action

No

String

Operation type. It can be:

• filter: Filter record.

• count: Count the total number of records.

tags

No

Array of Tag objects

Tag list, which is a collection of key-value pairs.

• key: Tag key. A CMK can have a maximum of 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. It consists of up to 36 characters.

• value: Tag value. Each tag value can contain a maximum of 43 characters. The values are in the AND relationship.

matches

No

Array of TagItem objects

Field to be matched.

• key: The field to be matched, for example, resource_name.

• value: The value to be matched. It contains a maximum of 255 characters and cannot be empty.

sequence

No

String

36-byte sequence number of a request message. Example: 919c82d4-8046-4722-9094-35c3c6524cff

key

No

String

Key. A tag key contains a maximum of 36 Unicode characters. It cannot be left blank. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (), and equal signs (=).

values

No

Array of strings

Tag value set.

key

No

String

Key. A tag key contains a maximum of 36 Unicode characters. It cannot be left blank. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (), and equal signs (=).

value

No

String

Value. A tag value can contain a maximum of 43 Unicode characters and can be an empty string. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (), and equal signs (=).

resources

Array of ActionResources objects

Resource list.

total_count

Integer

Total number of records.

resource_id

String

Resource ID.

resource_detail

KeyDetails object

Key details.

resource_name

String

Specifies the resource name. This parameter is an empty string by default.

tags

Array of TagItem objects

Tag list. If there is no tag in the list, an empty array is returned.

key_id

String

CMK ID.

domain_id

String

User domain ID.

key_alias

String

Key alias.

realm

String

Key realm.

key_spec

String

CMK algorithm type.

• AES_256

• RSA_2048

• RSA_3072

• RSA_4096

• EC_P256

• EC_P384

key_usage

String

CMK usage。

• ENCRYPT_DECRYPT

• SIGN_VERIFY

key_description

String

Key description.

creation_date

String

Time when the key was created. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).

scheduled_deletion_date

String

Time when the key was scheduled to be deleted. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).

key_state

String

Key status, which matches the regular expression ^[1-5]{1}$. It can be:

• 1: to be activated

• 2: enabled

• 3: disabled

• 4: pending deletion

• 5: pending import

default_key_flag

String

Master key identifier. The value is 1 for Default Master Keys and 0 for non-default master keys.

key_type

String

Key type.

expiration_time

String

Time when the key material expires. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).

origin

String

Key source. It can be:

• kms: The key material was generated by KMS.

• external: The key material was imported.

key_rotation_enabled

String

Key rotation status. The default value is false, indicating that key rotation is disabled.

sys_enterprise_project_id

String

Enterprise project ID. Its default value is 0.

• For users who have enabled the enterprise project function, this value indicates that resources are in the default enterprise project.

• For users who have not enabled the enterprise project function, this value indicates that resources are not in the default enterprise project.

key

String

Key. A tag key contains a maximum of 36 Unicode characters. It cannot be left blank. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (), and equal signs (=).

value

String

Value. A tag value can contain a maximum of 43 Unicode characters and can be an empty string. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (), and equal signs (=).

error

Object

Error message.

error_code

String

Error code.

error_msg

String

Error information.

error

Object

Error message.

error_code

String

Error code.

error_msg

String

Error information.

200

Request processing succeeded.

400

Invalid request parameters.

403

Authentication failed.