SearchRetcodeAppByPage - Application Real-Time Monitoring Service

Queries Browser Monitoring tasks by page.

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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
arms:SearchRetcodeAppByPage	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RetcodeAppName	string	Yes	The name of the application.	App1
PageNumber	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	5
RegionId	string	Yes	The region ID.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group. You can obtain the resource group ID in the Resource Management console.	rg-acfmxyexli2****
RetcodeAppId	string	No	The application ID. 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 browser address bar contains the pid of this application in the format of `pid=xxx`. 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 `xxx%4074xxx`, you must replace %40 with the at sign (@). The actual PID is `xxx@74xxx`.	eb4zdose6v@9781be0f44d****
Tags	array<object>	No	The tag.
	object	No
Key	string	No	The tag key.	TestKey
Value	string	No	The tag value.	TestValue

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	626037F5-FDEB-45B0-804C-B3C92797A64E
PageBean	object	The returned page information.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	2
TotalCount	integer	The total number of returned entries.	8
RetcodeApps	array<object>	The browser monitoring tasks that are returned.
RetcodeApp	object
Type	string	The type of the monitoring task. Valid values: `TRACE`: Application Monitoring `RETCODE`: Browser Monitoring	RETCODE
AppName	string	The name of the application.	a3
RetcodeAppType	string	The type of the application. Valid values: `web`: web application `weex`: Weex mobile app `mini_dd`: DingTalk mini program `mini_alipay`: Alipay mini program `mini_wx`: WeChat mini program `mini_common`: mini program on other platforms	web
UpdateTime	long	The time when the task was updated.	1545363321000
CreateTime	long	The time when the task was created.	1545363321000
Pid	string	The process identifier (PID) of the application.	eb4zdose6v@9781be0f44d****
AppId	long	The ID of the application. The parameter is an auto-increment parameter.	16064
UserId	string	The user ID.	12341234
RegionId	string	The region ID.	cn-hangzhou
NickName	string	The alias of the application.	c1
ResourceGroupId	string	The ID of the resource group.	rg-acfmxyexli2****
Tags	array<object>	The tag.
Tags	object
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue

Examples

Sample success responses

JSONformat

{
  "RequestId": "626037F5-FDEB-45B0-804C-B3C92797A64E",
  "PageBean": {
    "PageNumber": 1,
    "PageSize": 2,
    "TotalCount": 8,
    "RetcodeApps": [
      {
        "Type": "RETCODE",
        "AppName": "a3",
        "RetcodeAppType": "web",
        "UpdateTime": 1545363321000,
        "CreateTime": 1545363321000,
        "Pid": "eb4zdose6v@9781be0f44d****",
        "AppId": 16064,
        "UserId": "12341234",
        "RegionId": "cn-hangzhou",
        "NickName": "c1",
        "ResourceGroupId": "rg-acfmxyexli2****",
        "Tags": [
          {
            "Key": "TestKey",
            "Value": "TestValue"
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-09-27	The response structure of the API has changed	View Change Details