Querying the Information About a CMK

Function

This API allows you to query the details about a CMK.

URI

• URI format

  POST /v1.0/{project_id}/kms/describe-key

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID

Requests

Table 2 Request parameters

Parameter	Mandatory	Type	Description
key_id	Yes	String	36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$ Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
sequence	No	String	36-byte serial number of a request message Example: 919c82d4-8046-4722-9094-35c3c6524cff

Responses

Table 3 Response parameters

Parameter	Mandatory	Type	Description
key_info	Yes	Array of objects	Information about keys. For details, see Table 4.

Table 4 key_info field description

Parameter	Mandatory	Type	Description
key_id	Yes	String	CMK ID
domain_id	Yes	String	User domain ID
key_alias	Yes	String	Alias of a CMK
realm	Yes	String	Region where a CMK resides
key_description	Yes	String	Description of a CMK
key_spec	Yes	String	Key generation algorithm. Its value can be: AES_256 SM4 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2
key_usage	Yes	String	Key usage. Its value can be: ENCRYPT_DECRYPT SIGN_VERIFY
creation_date	Yes	String	Time when a key is created. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970.
scheduled_deletion_date	Yes	String	Time when a key will be deleted as scheduled. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970.
key_state	Yes	String	State of a CMK: 1 indicates that the CMK is waiting to be activated. 2 indicates that the CMK is enabled. 3 indicates that the CMK is disabled. 4 indicates that the CMK is scheduled for deletion.
default_key_flag	Yes	String	Identification of a Master Key. The value 1 indicates a Default Master Key, and the value 0 indicates a CMK.
key_type	Yes	String	Type of a CMK
expiration_time	Yes	String	Expiration time of the key material. It is expressed in the form of a time stamp, the total number of seconds since January 1, 1970.
origin	Yes	String	Origin of a CMK. The default value is kms. The following values are enumerated:

Examples

The following example describes how to query the information of a CMK whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.

• Example request

  {
      "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
  }
  

• Example response

  {
      "key_info": {
          "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
          "domain_id": "b168fe00ff56492495a7d22974df2d0b",
          "key_alias": "kms_test",
          "realm": "aaa",
          "key_description": "",
          "creation_date": "1472442386000",
          "scheduled_deletion_date": "",
          "key_state": "2",
          "default_key_flag": "0",
          "key_type": "1",
          "expiration_time":"1501578672000",
          "origin":"kms"
          ,
      }
  }
  

  or

  {
      "error": {
          "error_code": "KMS.XXXX",
          "error_msg": "XXX"
      }
  }
  

Status Codes

Table 5 lists the normal status code returned by the response.

Table 5 Status codes

Status Code	Status	Description
200	OK	Request processed successfully.

Exception status code. For details, see Status Codes.

last updated: 2024-11-08 14:06 UTC - commit: 5674aac1874f8e8728192583f58d6e232d714273