All Products
Search
Document Center

Application Real-Time Monitoring Service:DescribeIMRobots

Last Updated:Nov 05, 2024

Queries a list of IM chatbots.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RobotNamestringNo

The name of the IM chatbot.

Chatbot name
PagelongYes

The number of the page to return.

1
SizelongYes

The number of IM chatbots to return on each page.

20
RobotIdsstringNo

The chatbot IDs.

123

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

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

The returned objects.

Totallong

The total number of queried IM chatbots.

1
Pagelong

The page number of the returned page.

1
Sizelong

The number of IM chatbots returned per page.

20
AlertIMRobotsarray<object>

The queried IM chatbots.

IMRobotsobject
RobotIdfloat

The ID of the IM chatbot.

123
Typestring

The type of the IM chatbot. Valid values:

  • dingding: DingTalk chatbot
  • wechat: WeCom chatbot
dingding
RobotNamestring

The name of the IM chatbot.

Chatbot name
RobotAddrstring

The webhook URL of the IM chatbot.

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

Indicates whether daily statistics are sent. Valid values:

  • false (default): Daily statistics are not sent.
  • true: Daily statistics are sent.
true
DailyNocTimestring

The point in time at which the daily statistics are sent. The information that ARMS sends at the specified points in time includes the total number of alerts generated on the current day, the number of cleared alerts, and the number of alerts to be cleared.

09:30,17:30
DingSignKeystring

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

******
CreateTimestring

The time when the IM chatbot was created.

2023-01-16 17:21:48
DispatchRulesarray<object>

The notification policies.

DispatchRuleobject
idlong

The ID of the notification policy.

12345
namestring

The name of the notification policy.

Notification policy test

Examples

Sample success responses

JSONformat

{
  "RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "AlertIMRobots": [
      {
        "RobotId": 123,
        "Type": "dingding",
        "RobotName": "Chatbot name\n",
        "RobotAddr": "https://oapi.dingtalk.com/robot/send?access_token=e1a049121******",
        "DailyNoc": true,
        "DailyNocTime": "09:30,17:30",
        "DingSignKey": "******",
        "CreateTime": "2023-01-16 17:21:48",
        "DispatchRules": [
          {
            "id": 12345,
            "name": "Notification policy test\n"
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-09The internal configuration of the API is changed, but the call is not affectedView Change Details