Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Management APIs/ Querying Keys/ Querying the Instance Quantity
Updated on 2025-09-15 GMT+08:00
View PDF

Querying the Instance Quantity

Function

This API is used to query the number of instances, that is, the number of CMKs created by a user.

Calling Method

For details, see Calling APIs.

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. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_num

Integer

Number of non-default CMKs.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 5 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 7 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 9 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 11 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 13 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 502

Table 14 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 15 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 504

Table 16 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 17 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Example Requests

Query the number of instances created in the project whose ID is 0dea2644dc80d5d22ff1c01e3ebea6fc.

/v1.0/0dea2644dc80d5d22ff1c01e3ebea6fc/kms/user-instances

Example Responses

Status code: 200

Request succeeded.

{
  "instance_num" : 15
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request parameters.

401

Username and password are required for the requested page.

403

Authentication failed.

404

The resource does not exist.

500

Internal service error.

502

Failed to complete the request. The server receives an invalid response from the upstream server.

504

Gateway timed out.

Error Codes

See Error Codes.

Parent Topic: Querying Keys