All Products
Search
Document Center

Application Real-Time Monitoring Service:GetRetcodeDataByQuery

Last Updated:Nov 05, 2024

Queries the Browser Monitoring data based on a query statement of Log Service.

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.

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 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.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetRetcodeDataByQueryget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PidstringYes

The ID of the application.

Log on to the ARMS console. In the left-side navigation pane, choose Browser Monitoring > Browser Monitoring. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d****, you must replace %40 with an at sign (@) to obtain eb4zdose6v@9781be0f44d****.

atc889zkcf@d8deedfa9bf****
QuerystringYes

The query statement that conforms to the query syntax of a Log Service Logstore.

t : pv|select sum(times) as pv , approx_distinct(uid) as uv , (date-date%3600000) as date group by date
FromlongYes

The beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1668687302
TolongYes

The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1668688000
RegionIdstringYes

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Codestring

The HTTP status code returned for the request. Valid values:

  • 2XX: The request was successful.
  • 3XX: A redirection message was returned.
  • 4XX: The request was invalid.
  • 5XX: A server error occurred.
200
Messagestring

The error message returned if the call fails.

Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Datastring

The Browser Monitoring data returned.

{"total":0,"auth":false,"pageSize":20,"completed":true,"page":1,"items":[]}

Examples

Sample success responses

JSONformat

{
  "RequestId": "2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "Code": "200",
  "Message": "Internal error. Please try again. Contact the DingTalk service account if the issue                              persists after multiple retries.",
  "Success": true,
  "Data": "{\"total\":0,\"auth\":false,\"pageSize\":20,\"completed\":true,\"page\":1,\"items\":[]}"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history