Queries the statistics about a version of an OpenSearch application.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| opensearch:DescribeAppStatistics |
|
| none |
Request syntax
GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/statistics HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| appGroupIdentity | string | Yes | The name of the application. | my_app_group_name |
| appId | string | Yes | The version number of the application. | 110157886 |
Response parameters
Statistical results
| Parameter | Type | Description |
|---|---|---|
| result.pv | Integer | The number of requests. |
| result.docCount | Integer | The number of documents. |
| result.docLastUpdated | String | The timestamp when the document was last updated. |
| result.quota | Object | The statistics about the quotas. |
| result.quota.instance | Object | The statistics about the instance. |
| result.quota.instance.used | Float | The used quota. Unit: LCUs. |
| result.quota.instance.quota | Integer | The quota capacity. Unit:GB. |
| result.quota.instance.outOfLimit | Boolean | Indicates whether the quotas are exceeded. |
| result.quota.instance.tables | Object | The statistics used by each data table.The key name is the name of the table, and the value is the used capacity. |
| result.quota.qps | Object | The statistics about the quota of queries per second (QPS). |
| result.quota.qps.used | Float | The used quota of QPS. |
| result.quota.qps.quota | Integer | The total quota of QPS. |
| result.quota.qps.outOfLimit | Boolean | Indicates whether the quotas are 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 computing resources. Unit: LCUs. |
| result.quota.computeResource.quota | Integer | The quota of computing resources. Unit: GB. |
| result.quota.computeResource.outOfLimit | Boolean | Indicates whether the quotas are exceeded. |
| result.quota.computeResource.dailyPeak | Float | The maximum amount of computing resources used. Unit: LCUs. |
| result.quota.spec | String | The specifications of the application. Valid values:opensearch.share.junior: basicopensearch.share.common: shared general-purposeopensearch.share.compute: shared computingopensearch.share.storage: shared storageopensearch.private.common: exclusive general-purposeopensearch.private.compute: exclusive computingopensearch.private.storage: exclusive storage |
| result.quota.docCount | Object | The statistics of the document number.The key indicates the name of the table. The value indicates the used quotas. |
| result.quota.mainTable | String | The name of the primary table. |
Examples
Sample success responses
JSONformat
{
"result": {},
"requestId": "76FC45F1-4167-D3CD-6737-4F97BA503FA0"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history