All Products
Search
Document Center

Application Real-Time Monitoring Service:CreateRetcodeApp

Last Updated:Nov 05, 2024

Creates a Browser Monitoring task for an application.

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:CreateRetcodeAppnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RetcodeAppNamestringYes

The name of the application.

SdkTest
RetcodeAppTypestringYes

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

A5EC8221-08F2-4C95-9AF1-49FD998C647A
Codeinteger

The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.

200
Datastring

The response parameters.

bdidt76ehx@d5cf1cd3f7df411
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
True
Messagestring

The message returned.

success
RetcodeAppDataBeanobject

The information of the Browser Monitoring task.

Pidstring

The process identifier (PID) of the application.

aokcdqn3ly@a195c6d6421****
AppIdlong

The application ID.

135143
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": "A5EC8221-08F2-4C95-9AF1-49FD998C647A",
  "Code": 200,
  "Data": "bdidt76ehx@d5cf1cd3f7df411",
  "Success": true,
  "Message": "success",
  "RetcodeAppDataBean": {
    "Pid": "aokcdqn3ly@a195c6d6421****",
    "AppId": 135143,
    "ResourceGroupId": "rg-acfmxyexli2****",
    "Tags": {
      "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-07-27The response structure of the API has changedView Change Details