GetRumOcuStatisticData - Application Real-Time Monitoring Service

Queries the observability capacity unit (OCU) usage data of Real User Monitoring (RUM).

Operation description

You can query the usage data for the current day at any time. You can query the usage data for the previous day only after 8:00 today.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is 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
arms:GetRumOcuStatisticData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	long	Yes	The beginning of the time range to query. Unit: milliseconds.	1600063200000
EndTime	long	Yes	The end of the time range to query. Unit: milliseconds.	1687849260000
QueryType	string	No	The type of the query. To query non-time series data, set the value to INSTANT. To query time series data, set the value to TIME_SERIES.	TIME_SERIES
Filter	array<object>	No	The filter condition. Three types of filter conditions are provided: Application name: pid (Note that the application name is displayed, but the application ID is actually specified) Application type: siteType Data type: dataType
	object	No
Key	string	No	The key of the filter condition. Three types of filter conditions are provided: Application name: pid (Note that the application name is displayed, but the application ID is actually specified) Application type: siteType Data type: dataType	pid
OpType	string	No	The type of the operator. Valid value: in.	in
Value	any	No	The value of the filter condition. The value is a JSON array of strings.	["b590xxxxx@2dcbxxxxx9", "b590xxxxx@2dcbxxxxx8"]
Group	array	No	The grouping fields. Valid values: siteType: The total number of OCUs is grouped by application type. dataType: The total number of OCUs is grouped by data type. pid: The total number of OCUs is grouped by application ID. appName: The total number of OCUs is grouped by application name. startTime: The total number of OCUs is grouped by start time.
	string	No	The grouping key.	[ "siteType", "dataType" ]
Page	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	100
RegionId	string	No	The region ID.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	626037F5-FDEB-45B0-804C-B3C92797****
Code	long	The HTTP status code. The status code 200 indicates that the request was successful.	200
Message	string	The error message returned if the request failed.	null
Data	object	The returned struct.
Items	array<object>	The queried data.
Item	object	The details of the queried data, in the JSON Map format.
	any	The queried data.	{ "totalChargedSessionCount": "11008", "__time__": 1717948800, "appName": "Main console", "totalOcu": "55", "startTime": "1719244800", "pid": "b5xxxxxuqs@1f59cxxxxxxxxxb", "totalCount": "11" }
Total	integer	The total number of entries returned.	100
Page	integer	The page number.	1
PageSize	integer	The number of entries per page.	100
Complete	boolean	Indicates whether the next page exists.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "626037F5-FDEB-45B0-804C-B3C92797****",
  "Code": 200,
  "Message": null,
  "Data": {
    "Items": [
      {
        "key": {
          "totalChargedSessionCount": 11008,
          "__time__": 1717948800,
          "appName": "Main console",
          "totalOcu": 55,
          "startTime": 1719244800,
          "pid": "b5xxxxxuqs@1f59cxxxxxxxxxb",
          "totalCount": 11
        }
      }
    ],
    "Total": 100,
    "Page": 1,
    "PageSize": 100,
    "Complete": true
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-16	The internal configuration of the API is changed, but the call is not affected	View Change Details