All Products
Search
Document Center

Application Real-Time Monitoring Service:GetRetcodeAppByPid

Last Updated:May 09, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PidstringNo

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
RegionIdstringNo

The ID of the region.

cn-hangzhou
Tagsobject []No

The list of tags.

KeystringNo

The tag key.

TestKey
ValuestringNo

The tag value.

TestValue

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

2983BEF7-4A0D-47A2-94A2-8E9C5E63****
RetcodeAppobject

The returned application data.

AppNamestring

The name of the application that is monitored by Browser Monitoring.

testRetcodeAppXXXX
RetcodeAppTypestring

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
AppIdstring

The ID of the application. The parameter is an auto-increment parameter.

2787XXXX
Pidstring

The process identifier (PID) of the application.

b590lhguqs@9781be0f44dXXXX
ResourceGroupIdstring

The ID of the resource group. You can obtain the resource group ID in the Resource Management console.

rg-acfmxidtzXXXX
Tagsobject []

The tags that are attached to the instance.

Keystring

The key of the tag.

testKey
Valuestring

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 timeSummary of changesOperation
2023-06-28The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tags