All Products
Search
Document Center

Application Real-Time Monitoring Service:DescribeIMRobots

Last Updated:Mar 22, 2023

You can call the DescribeIMRobots operation to query the list of IM robots.

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 keyAssociation operation
arms:SearchContactRead
  • ARMS
    acs:arms:*:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RobotNamestringNo

The name of the IM robot.

robot name
PagelongYes

The number of pages to query.

1
SizelongYes

The number of IM robots displayed on each page.

20
RobotIdsstringNo

The ID of the IM bot.

123

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

4D6C358A-A58B-4F4B-94CE-F5AAF023****
PageBeanobject

Paging object.

Totallong

The total number of IM robots queried.

1
Pagelong

The number of pages to query.

1
Sizelong

Number of IM robots per page.

20
AlertIMRobotsarray

The details of the IM robot.

object
RobotIdfloat

The ID of the IM bot.

123
Typestring

IM Robot Type:

  • dingding: DingTalk robot.
  • wechat: Enterprise WeChat Robot.
dingding
RobotNamestring

The name of the IM robot.

robot name
RobotAddrstring

The webhook address of the IM bot.

https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNocboolean

Specifies whether to send daily statistics.

  • false (default): does not send statistics.
  • true: sends statistics.
true
DailyNocTimestring

The time when the daily statistics are sent. ARMS Alert Management sends the total number of alerts generated today, the number of resolved alerts, and the number of pending alerts at the specified time point.

09:30,17:30
DingSignKeystring

The signature key of DingTalk. If you specify a signature key, DingTalk authentication is performed with the key. Otherwise, a whitelist is used for authentication by default. The keyword of the whitelist is Alert.

******

Examples

Sample success responses

JSONformat

{
  "RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "AlertIMRobots": [
      {
        "RobotId": 123,
        "Type": "dingding",
        "RobotName": "robot name",
        "RobotAddr": "https://oapi.dingtalk.com/robot/send?access_token=e1a049121******",
        "DailyNoc": true,
        "DailyNocTime": "09:30,17:30",
        "DingSignKey": "******"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history