All Products
Search
Document Center

Application Real-Time Monitoring Service:ListRetcodeApps

Last Updated:Nov 05, 2024

Queries the Browser Monitoring tasks in a region.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ResourceGroupIdstringNo

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

rg-acfmxyexli2****
Tagsarray<object>No

The tags that you want to add to the task.

objectNo
KeystringNo

The tag key.

TestKey
ValuestringNo

The tag value.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

99A663CB-8D7B-4B0D-A006-03C8EE38E7BB
RetcodeAppsarray<object>

The list of applications monitored by Browser Monitoring.

RetcodeAppobject
AppNamestring

The name of the application.

A1
RetcodeAppTypestring

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
AppIdlong

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

16064
Pidstring

The process identifier (PID) of the application.

atc889zkcf@d8deedfa9bf****
NickNamestring

The alias of the application monitored by Browser Monitoring.

B1
ResourceGroupIdstring

The ID of the resource group.

rg-acfmxyexli2****
Tagsarray<object>

The tags of the task.

Tagsobject
Keystring

The tag key.

TestKey
Valuestring

The tag value.

TestValue

Examples

Sample success responses

JSONformat

{
  "RequestId": "99A663CB-8D7B-4B0D-A006-03C8EE38E7BB",
  "RetcodeApps": [
    {
      "AppName": "A1",
      "RetcodeAppType": "web",
      "AppId": 16064,
      "Pid": "atc889zkcf@d8deedfa9bf****",
      "NickName": "B1",
      "ResourceGroupId": "rg-acfmxyexli2****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2022-09-21The response structure of the API has changedView Change Details