All Products
Search
Document Center

:DescribeQuota

Last Updated:Mar 01, 2024

Queries the quotas of an instance based on a specified instance ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v2/openapi/instances/{instanceId}/quota

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

airec-cn-o400whm78004

Response parameters

ParameterTypeDescriptionExample
object
resultobject

The quotas of the instance.

itemCountUsedlong

The number of items that are used in the item table.

100
itemCountlong

The number of documents in the item table. Valid values:

1000000 to 10000000.

1000000
userCountlong

The number of documents in the user table. Valid values:

1000000 to 10000000.

1000000
userCountUsedlong

The number of users that are used in the user table.

100
qpsinteger

The queries per second (QPS). Valid values:

10 to 500.

10
currentQpsinteger

The current QPS.

8
codestring

The error code.

InternalServerError
requestIdstring

The request ID.

8F81A922-6C81-46D6-B78C-CC35E16B1691
messagestring

The error message.

An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": {
    "itemCountUsed": 100,
    "itemCount": 1000000,
    "userCount": 1000000,
    "userCountUsed": 100,
    "qps": 10,
    "currentQps": 8
  },
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history