GetRetcodeAppByPid - Application Real-Time Monitoring Service

Queries the objects of a Browser Monitoring application by process identifier (PID).

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:GetRetcodeApp	none	RetcodeApp acs:arms:{#regionId}:{#accountId}:retcodeapp/{#RetcodeAppId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
Pid	string	No	The PID of the application. To obtain the PID of the application, perform the following steps: Log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose Browser Monitoring > Browser Monitoring. On the Browser Monitoring page, click the name of the application. The URL in the address bar contains the PID of the application. The PID is 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 xxx%4074xxx, you must replace %40 with the at sign (@) to obtain xxx@74xxx.	b590lhguqs@9781be0f44dXXXX
RegionId	string	No	The ID of the region.	cn-hangzhou
Tags	array<object>	No	The list of tags.
	object	No
Key	string	No	The tag key.	TestKey
Value	string	No	The tag value.	TestValue

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	2983BEF7-4A0D-47A2-94A2-8E9C5E63****
RetcodeApp	object	The returned application data.
AppName	string	The name of the application that is monitored by Browser Monitoring.	testRetcodeAppXXXX
RetcodeAppType	string	The type of the application that is monitored by Browser Monitoring. 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
AppId	string	The ID of the application. The parameter is an auto-increment parameter.	2787XXXX
Pid	string	The process identifier (PID) of the application.	b590lhguqs@9781be0f44dXXXX
ResourceGroupId	string	The ID of the resource group. You can obtain the resource group ID in the Resource Management console.	rg-acfmxidtzXXXX
Tags	array<object>	The tags that are attached to the instance.
Tags	object
Key	string	The key of the tag.	testKey
Value	string	The value of the tag.	testValue

Examples

Sample success responses

JSONformat

{
  "RequestId": "2983BEF7-4A0D-47A2-94A2-8E9C5E63****",
  "RetcodeApp": {
    "AppName": "testRetcodeAppXXXX",
    "RetcodeAppType": "web",
    "AppId": "2787XXXX",
    "Pid": "b590lhguqs@9781be0f44dXXXX",
    "ResourceGroupId": "rg-acfmxidtzXXXX",
    "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
2024-06-19	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-06-28	The request parameters of the API has changed	View Change Details