ListIntegration - Application Real-Time Monitoring Service

Views a list of alert integrations.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
arms:ListIntegration	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
IntegrationName	string	No	The name of the alert integration.	CloudMonitor integration
IntegrationProductType	string	Yes	The type of the alert integration. Valid values: CLOUD_MONITOR: CloudMonitor LOG_SERVICE: Log Service	CLOUD_MONITOR
Page	long	Yes	The number of the page to return.	1
Size	long	Yes	The number of alert integrations to return on each page.	10
IsDetail	boolean	No	Specifies whether to display the details of each alert integration: true false	true

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	34ED024E-9E31-434A-9E4E-D9D15C3****
PageInfo	object	The pagination information.
Total	long	The total number of alert integrations.	1
Size	long	The number of alert integrations returned per page.	10
Page	long	The page number of the returned page.	1
Integrations	array<object>	The information about each alert integration.
integrations	object
IntegrationId	long	The ID of the alert integration.	1234
IntegrationName	string	The name of the alert integration.	CloudMonitor integration
IntegrationProductType	string	The type of the alert integration. Valid values: CLOUD_MONITOR: CloudMonitor LOG_SERVICE: Log Service	CLOUD_MONITOR
ApiEndpoint	string	The endpoint of the alert integration.	https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******
ShortToken	string	The authentication token of the alert integration.	ymQBN******
State	boolean	Indicates whether the alert integration was enabled. Valid values: true false	true
Liveness	string	The activity of the alert integration	ready
CreateTime	string	The time when the alert integration was created.	2022-06-18
IntegrationDetail	object	The information about the alert events.
Description	string	The description of the alert integration.	Test
DuplicateKey	string	The fields whose values are deduplicated.	LABEL.alertname::LABEL.severity
AutoRecover	boolean	Indicates whether alert events are automatically cleared. Valid values: true (default) false	true
RecoverTime	long	The time when alert events are automatically cleared. Unit: seconds. Default value: 300.	300
Stat	array	The total number of alert events and the number of abnormal alert events in the last hour.
stat	long	The total number of alert events and the number of abnormal alert events in the last hour.	[0,0]
FieldRedefineRules	array<object>	The predefined mapped fields of the alert source.
fieldRedefineRules	object	The predefined mapped fields are mapped to the fields of ARMS alerts. The predefined mapped fields were generated when the alert integration was created.
ExtendedFieldRedefineRules	array<object>	The extended mapped fields of the alert source.
extendedFieldRedefineRules	object	The extended mapped fields are mapped to the fields of ARMS alerts.	[ { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"dimensions", "expression":null, "mappingRuleList":[ ], "name":"dimensions", "integrationId":1234, "jsonPath":"$.dimensions", "id":10013, "fieldType":"LABEL" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"expression", "expression":null, "mappingRuleList":[ ], "name":"expression", "integrationId":1234, "jsonPath":"$.expression", "id":10014, "fieldType":"LABEL" } ]
InitiativeRecoverField	string	The field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events. Note Only the Log Service alert integration supports the parameter.	$.status
InitiativeRecoverValue	string	The value of the field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events. Note Only the Log Service alert integration supports the parameter.	ok

Examples

Sample success responses

JSONformat

{
  "RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
  "PageInfo": {
    "Total": 1,
    "Size": 10,
    "Page": 1,
    "Integrations": [
      {
        "IntegrationId": 1234,
        "IntegrationName": "CloudMonitor integration\n",
        "IntegrationProductType": "CLOUD_MONITOR",
        "ApiEndpoint": "https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******",
        "ShortToken": "ymQBN******",
        "State": true,
        "Liveness": "ready",
        "CreateTime": "2022-06-18",
        "IntegrationDetail": {
          "Description": "Test\n",
          "DuplicateKey": "LABEL.alertname::LABEL.severity",
          "AutoRecover": true,
          "RecoverTime": 300,
          "Stat": [
            0
          ],
          "FieldRedefineRules": [
            {
              "test": "test",
              "test2": 1
            }
          ],
          "ExtendedFieldRedefineRules": [
            [
              {
                "redefineType": "EXTRACT",
                "matchExpression": null,
                "fieldName": "dimensions",
                "expression": null,
                "mappingRuleList": [],
                "name": "dimensions",
                "integrationId": 1234,
                "jsonPath": "$.dimensions",
                "id": 10013,
                "fieldType": "LABEL"
              },
              {
                "redefineType": "EXTRACT",
                "matchExpression": null,
                "fieldName": "expression",
                "expression": null,
                "mappingRuleList": [],
                "name": "expression",
                "integrationId": 1234,
                "jsonPath": "$.expression",
                "id": 10014,
                "fieldType": "LABEL"
              }
            ]
          ],
          "InitiativeRecoverField": "$.status",
          "InitiativeRecoverValue": "ok"
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-08-11	The response structure of the API has changed	View Change Details