Updated on 2026-09-21 GMT+08:00

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

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_num

Integer

Definition

Number of non-default CMKs

Range

N/A

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.

Error Codes

See Error Codes.