All Products
Search
Document Center

Application Real-Time Monitoring Service:ClaimAlarm

Last Updated:Nov 05, 2024

Claims an alert. This operation can be used together with escalation policies. When multiple handlers are involved in alert management, each handler can call this operation to claim alerts. After an alert is claimed, the alert enters the Being Processed state.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
AlarmIdlongYes

The ID of the alert.

For more information about how to obtain the ID of an alert, see ListAlertEvents .

30
HandlerIdlongNo

The ID of the handler.

2046076

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

6A9AEA84-7186-4D8D-B498-4585C6A2****
Resultboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codelong

The HTTP status code. The status code 200 indicates that the request was successful.

200
Successboolean

Indicates whether the request was successful. Valid values:

true

false

true
Messagestring

The returned message.

success

Examples

Sample success responses

JSONformat

{
  "RequestId": "6A9AEA84-7186-4D8D-B498-4585C6A2****",
  "Result": true,
  "Code": 200,
  "Success": true,
  "Message": "success"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history