Li, Qiao dfe65b9551 KMS API 20230817 version.

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

2024-04-02 13:42:22 +00:00

9.0 KiB

Raw Permalink 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 Parameter description
Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

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

Requests

None

Responses

**Table 2** 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 3 lists the normal status code returned by the response.

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

Exception status code. For details, see Status Codes.

Parent topic: CMK Management

9.0 KiB Raw Permalink Blame History