Help Center> Data Encryption Workshop> API Reference> APIs> Key Management APIs> Querying APIs> Querying the Number of Instances
View PDF

Querying the Number of Instances

Function

This API is used to query the number of instances, that is, the number of CMKs created."

Constraints

Default Master Keys are automatically created by services and are not included in this query.

URI

GET /v1.0/{project_id}/kms/user-instances

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

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).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_num

Long

Number of non-default CMKs.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 5 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Example Requests

None

Example Responses

Status code: 200

Request processing succeeded.

{
  "instance_num" : 15
}

Status code: 403

Authentication failed.

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

Status Codes

Status Code

Description

200

Request processing succeeded.

403

Authentication failed.

Error Codes

See Error Codes.

Parent topic: Querying APIs