Queries the statistics about a version of an OpenSearch application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId]/statistics HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.

appId String Path Yes 110157886

The ID of the version.

Response parameters

Parameter Type Example Description
requestId String 76FC45F1-4167-D3CD-6737-4F97BA503FA0

The ID of the request.

result Map {}

The statistics.

Parameters in the result parameter

Parameter

Type

Description

result.pv

Integer

The number of search requests.

result.docCount

Integer

The number of documents.

result.docLastUpdated

String

The timestamp when the documents were last updated.

result.quota

Object

The statistics about the quotas.

result.quota.instance

Object

The statistics about the quotas of the application.

result.quota.instance.used

Float

The used quotas.

result.quota.instance.quota

Integer

The total quotas.

result.quota.instance.outOfLimit

Boolean

Indicates whether the quotas are exceeded.

result.quota.instance.tables

Object

The statistics about the quotas that are used by each table.

The statistics of each table are presented as a key-value pair. The key indicates the name of the table. The value indicates the used quotas.

result.quota.qps

Object

The statistics about the quota of queries per second (QPS).

result.quota.qps.used

Float

The used quota of QPS, which is the number of search requests that are sent.

result.quota.qps.quota

Integer

The total quota of QPS, which is the maximum number of search requests that are allowed.

result.quota.qps.outOfLimit

Boolean

Indicates whether the quota of QPS is exceeded.

result.quota.qps.tables

Array

--

result.quota.computeResource

Object

The statistics about the quota of computing resources.

result.quota.computeResource.used

Float

The used quota of computing resources.

result.quota.computeResource.quota

Integer

The total quota of computing resources.

result.quota.computeResource.outOfLimit

Boolean

Indicates whether the quota of computing resources is exceeded.

result.quota.computeResource.dailyPeak

Float

The peak usage of computing resources.

result.quota.spec

String

The specifications.

result.quota.docCount

Object

The statistics about the quota of the document quantity.

The statistics of each table are presented as a key-value pair. The key indicates the name of the table. The value indicates the used quota of the document quantity.

result.quota.mainTable

String

The name of the primary table.

Examples

Sample requests

GET /v4/openapi/app-groups/os_function_test_v1/apps/1100556/statistics

Sample success responses

XML format

<requestId>76FC45F1-4167-D3CD-6737-4F97BA503FA0</requestId>
<result>
    <pv>5002</pv>
    <docCount>168</docCount>
    <docLastUpdated>1582522280</docLastUpdated>
    <quota>
        <instance>
            <used>0.000002</used>
            <quota>1</quota>
            <outOfLimit>false</outOfLimit>
            <tables>
                <main>2222</main>
            </tables>
        </instance>
        <qps>
            <used>0</used>
            <quota>0</quota>
            <outOfLimit>false</outOfLimit>
        </qps>
        <computeResource>
            <used>0</used>
            <quota>20</quota>
            <outOfLimit>false</outOfLimit>
            <dailyPeak>1.0306227624786388</dailyPeak>
        </computeResource>
        <spec>opensearch.share.common</spec>
        <docCount>
            <main>168</main>
        </docCount>
        <mainTable>main</mainTable>
    </quota>
</result>

JSON format

{
    "requestId": "76FC45F1-4167-D3CD-6737-4F97BA503FA0",
    "result": {
        "pv": 5002,
        "docCount": 168,
        "docLastUpdated": 1582522280,
        "quota": {
            "instance": {
                "used": 0.000002,
                "quota": 1,
                "outOfLimit": false,
                "tables": {
                    "main": 2222
                }
            },
            "qps": {
                "used": 0,
                "quota": 0,
                "outOfLimit": false
            },
            "computeResource": {
                "used": 0,
                "quota": 20,
                "outOfLimit": false,
                "dailyPeak": 1.0306227624786388
            },
            "spec": "opensearch.share.common",
            "docCount": {
                "main": 168
            },
            "mainTable": "main"
        }
    }
}

Error codes

For a list of error codes, visit the API Error Center.