API standard and pre-built SDKs in multi-language
This product (ARMS/2019-08-08) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Alert Management
| API | Title | Description |
|---|---|---|
| CreateIntegration | CreateIntegration | Creates an alert integration. |
| UpdateIntegration | UpdateIntegration | Modifies the information about an integration. |
| DeleteIntegrations | DeleteIntegrations | Deletes an alert integration. |
| ListIntegration | ListIntegration | Views a list of alert integrations. |
| CreateOrUpdateAlertRule | CreateOrUpdateAlertRule | Creates or modifies an alert rule. |
| DeleteAlertRule | DeleteAlertRule | Deletes an alert rule. |
| ListAlertEvents | ListAlertEvents | Queries historical alert events. |
| GetAlertRules | GetAlertRules | Queries alert rules. |
| CreateOrUpdateContact | CreateOrUpdateContact | Creates or modifies an alert contact. |
| SendTTSVerifyLink | SendTTSVerifyLink | Sends a text message to an alert contact to verify the mobile number of the alert contact. |
| DeleteContact | DeleteContact | Deletes alert contacts. |
| DescribeContacts | DescribeContacts | Queries alert contacts. |
| CreateOrUpdateContactGroup | CreateOrUpdateContactGroup | Creates or modifies an alert contact group. |
| DeleteContactGroup | DeleteContactGroup | Deletes an alert contact group. |
| DescribeContactGroups | DescribeContactGroups | Queries an alert contact group. |
| CreateOrUpdateIMRobot | CreateOrUpdateIMRobot | Creates or updates an IM chatbot. |
| DeleteIMRobot | DeleteIMRobot | Deletes an instant messaging (IM) chatbot. |
| DescribeIMRobots | DescribeIMRobots | Queries a list of IM chatbots. |
| CreateOrUpdateWebhookContact | CreateOrUpdateWebhookContact | Creates or modifies a webhook alert contact. |
| DeleteWebhookContact | DeleteWebhookContact | Deletes a webhook alert contact. |
| DescribeWebhookContacts | DescribeWebhookContacts | Queries the list of webhook alert contacts. |
| CreateOrUpdateEventBridgeIntegration | CreateOrUpdateEventBridgeIntegration | Creates or modifies an EventBridge integration that is used to push notifications. |
| DeleteEventBridgeIntegration | DeleteEventBridgeIntegration | Deletes an EventBridge integration that is used to push notifications. |
| ListEventBridgeIntegrations | ListEventBridgeIntegrations | Queries EventBridge integrations that are used to push notifications. |
| CreateOrUpdateNotificationPolicy | CreateOrUpdateNotificationPolicy | Creates or modifies a notification policy. |
| DeleteNotificationPolicy | DeleteNotificationPolicy | Deletes a notification policy based on its ID. |
| ListNotificationPolicies | ListNotificationPolicies | Queries notification policies based on specified conditions. |
| CreateOrUpdateSilencePolicy | CreateOrUpdateSilencePolicy | Creates or modifies a silence policy. |
| DeleteSilencePolicy | DeleteSilencePolicy | Deletes a silence policy based on its ID. |
| ListEscalationPolicies | ListEscalationPolicies | Queries the information about an escalation policy. |
| ListOnCallSchedules | ListOnCallSchedules | Queries the information about a scheduling policy. |
| GetOnCallSchedulesDetail | GetOnCallSchedulesDetail | Queries the information about a scheduling policy. |
| ListSilencePolicies | ListSilencePolicies | Queries the information of a silence policy list. |
| ListAlerts | ListAlerts | Queries the alert sending history. |
| BlockAlarmNotification | BlockAlarmNotification | Blocks alert notifications. After an alert is blocked, no more notifications are sent within the specified time range. |
| ChangeAlarmSeverity | ChangeAlarmSeverity | Modifies the severity level of an alert. |
| CloseAlarm | CloseAlarm | Disables an alert. Make sure that the alert is resolved before you disable the alert. If an alert is not resolved, new alerts can be triggered even after the alert is disabled. |
| ClaimAlarm | ClaimAlarm | 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. |
Service Activation
| API | Title | Description |
|---|---|---|
| OpenArmsServiceSecondVersion | OpenArmsServiceSecondVersion | Activates a specified pay-as-you-go sub-service of Application Real-Time Monitoring Service (ARMS). |
| OpenXtraceDefaultSLR | OpenXtraceDefaultSLR | Activates the service-linked role AliyunServiceRoleForXtrace for Tracing Analysis. |
| OpenArmsDefaultSLR | OpenArmsDefaultSLR | Activates the service-linked role AliyunServiceRoleForARMS for Application Real-Time Monitoring Service (ARMS). |
| ChangeResourceGroup | ChangeResourceGroup | Moves a resource to a specific resource group. |
| TagResources | TagResources | Adds tags to ARMS resources. |
| UntagResources | UntagResources | Removes tags from ARMS resources. |