Files

qiaoli 18397ded73 kms_api_2025042703

Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>

2025-12-09 09:29:44 +00:00

11 KiB

Raw Blame History

Querying the Number of Instances

Function

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

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

URI

URI format
GET /v1.0/{project_id}/kms/user-instances
Parameter description
Table 1 URI parameter
Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Requests

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Responses

**Table 3** Response parameters
Parameter	Mandatory	Type	Description
instance_num	Yes	Integer	Number of non-default CMKs

Examples

Example request
None

Example response

{ 
    "instance_num": 15
}

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

Status Codes

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

**Table 4** Status codes
Status Code	Status	Description
200	OK	Request processed successfully.

Exception status code. For details, see Status Codes.

Parent topic: CMK Management

11 KiB Raw Blame History