All Products
Search
Document Center

Application Real-Time Monitoring Service:SetRetcodeShareStatus

Last Updated:Nov 05, 2024

Turns on or turns off logon-free sharing for an application monitored by Browser Monitoring.

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

Request parameters

ParameterTypeRequiredDescriptionExample
PidstringYes

The process identifier (PID) of the application.

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 address bar contains the process ID (PID) of the application. The PID is indicated 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 eb4zdose6v%409781be0f44d****, you must replace %40 with @ to obtain eb4zdose6v@9781be0f44d****.

atc889zkcf@d8deedfa9bf****
StatusbooleanYes

Specifies whether to turn on or turn off the logon-free sharing switch. Valid values:

  • true: Turn on the switch.
  • false: Turn off the switch.
true
AppNamestringNo

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

test-app

Response parameters

ParameterTypeDescriptionExample
object
IsSuccessboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true
RequestIdstring

The ID of the request.

40B10E04-81E8-4643-970D-F1B38F2E****

Examples

Sample success responses

JSONformat

{
  "IsSuccess": true,
  "RequestId": "40B10E04-81E8-4643-970D-F1B38F2E****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history