Help Center/ Data Security Center/ API Reference/ API Description/ Masking Rules/ Obtaining Details About a KMS Key
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Details About a KMS Key

Function

This API is used to obtain details about a KMS key.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/sdg/server/mask/kms/describe-key

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

key_id

No

String

Key ID.

sequence

No

String

Request message sequence number.

Response Parameters

Status code: 200

OK

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Obtain details about a KMS key.

POST /v1/{project_id}/sdg/server/mask/kms/describe-key

{
  "key_id" : "xxxxxxxxxxxx",
  "sequence" : 30
}

Example Responses

Status code: 400

Invalid request.

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

Status code: 403

Request denied.

{
  "error_code" : "dsc.50000014",
  "error_msg" : "Repeat purchase"
}

Status Codes

Status Code

Description

200

OK

400

Invalid request.

403

Request denied.

Error Codes

See Error Codes.

Parent topic: Masking Rules