GetKmsInstanceQuotaInfos

更新时间:
复制 MD 格式

Queries the quota usage and limits for a KMS instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

KmsInstanceId

string

No

The ID of the KMS instance to query.

kst-bjj62f5ba3dnpb6v8****

ResourceType

string

No

The resource type. Valid values:

  • key: key quota

  • secret: secret quota

  • qps: queries per second (QPS) quota

  • vpc: Virtual Private Cloud (VPC) quota

Valid values:

  • qps :

    qps

  • vpc :

    vpc

  • secret :

    secret

  • key :

    key

key

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f

KmsInstanceId

string

The ID of the KMS instance.

kst-hzz6****

KmsInstanceQuotaInfos

array<object>

An array of quota details for the instance.

object

ResourceQuota

integer

The quota.

12

ResourceType

string

The resource type.

key

UsedQuantity

integer

The quota usage.

10

Examples

Success response

JSON format

{
  "RequestId": "f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f",
  "KmsInstanceId": "kst-hzz6****",
  "KmsInstanceQuotaInfos": [
    {
      "ResourceQuota": 12,
      "ResourceType": "key",
      "UsedQuantity": 10
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter The specified parameter is not valid. An invalid value is specified for the parameter.
403 Forbidden.DKMSInstanceStateInvalid The DKMS instance state is invalid. Your dedicated KMS instance is invalid.
403 Forbidden.DKMSInstanceNotFound The specified DKMS Instance is not found. Your dedicated KMS instance is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.