DocsICP FilingConsole
Documentation
Home Page Operations Incident Center Developer Reference API Reference API overview

API overview

Updated at:
Copy as MD
Product
My Favorites

API standards and multilingual preset SDKs

The OpenAPI of this product (GEMP/2021-04-13) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Integration configuration

API

Title

Description
CreateIntegrationConfig Create Integration Configuration Create an integration configuration.
DisableIntegrationConfig Disable the integration configuration Disable the integration configuration.
EnableIntegrationConfig Enable Integration Configuration Enable the integration configuration.
GetIntegrationConfig Integration configuration details Integration configuration details.
ListIntegrationConfigs Integration Configuration List Lists integration configurations.
ListIntegrationConfigTimelines Integration Configuration Operation Log Integration configuration operation log.
ConfirmIntegrationConfig Confirm Integration Configuration Confirm the integration configuration.
DeleteIntegrationConfig Delete integration configuration Delete an integration configuration.
UpdateIntegrationConfig Integration Configuration Update Integration configuration update.
RefreshIntegrationConfigKey Purge Integration key Purge the Integration key.

Personnel

API

Title

Description
GetUserGuideStatus Obtain the user onboarding status Obtain the user onboarding status.
UpdateUserGuideStatus Update the user guide status Update the user guide status.
ListUserSerivceGroups User Preview User preview

Service groups

API

Title

Description
ListServiceGroupMonitorSourceTemplates Query the message template list of a service group Lists message templates for a service group.
ListDataReportForServiceGroup Query service group management event statistical report Retrieves paginated statistics for service groups.
CheckWebhook Validate webhook Validate the validity of the webhook URL.
EnableServiceGroupWebhook Enable the webhook for a service group Enable the webhook for a service group.
CreateServiceGroup Create a service group Creates a service group.
DeleteServiceGroup Delete service group Delete a service group.
DeleteServiceGroupUser Delete a member from a service group Delete a member from a service group.
GetServiceGroup View service group details View the details of a service group.
ListServiceGroups Query service group list Retrieves the list of service groups.
UpdateServiceGroup Edit a service group Updates a service group.
DisableServiceGroupWebhook Disable the webhook of a service group Disable the webhook of a service group.

Scheduling

API

Title

Description
GetServiceGroupSpecialPersonScheduling Query the service group scheduling for a specified user Query the schedule for a specified person in a service group.
GetServiceGroupSchedulingPreview Preview service group scheduling Preview service group scheduling.
GetServiceGroupPersonScheduling Query the schedule of a service group for a specific user Query the schedule of a service group for a specific user.
CreateServiceGroupScheduling Create a service group schedule Create a new service group scheduling.
GetServiceGroupScheduling Query service group scheduling details Queries the scheduling details of a service group.
UpdateServiceGroupSpecialDayScheduling Modify the service group scheduling for a specified date Updates service group scheduling for a specific date.
UpdateServiceGroupScheduling Modify the service group scheduling Update the scheduling configuration for a service group.

Escalation rules

API

Title

Description
CreateRouteRule Create a stream routing rule Creates a routing rule.
DeleteRouteRule Delete a stream rule Deletes a routing rule.
DisableRouteRule Disable Rule Disable a rule.
EnableRouteRule Enable Rule Enables a routing rule.
GetRouteRule View rule details View rule details.
ListRouteRules 查询规则列表 Query the list of rules.
UpdateRouteRule Edit stream routing rules Update a routing rule.
VerifyRouteRule Authenticate stream routing rule Verifies a routing rule.

Events

API

Title

Description
CreateIncidentSubtotal Add a subtotal to a management event Add a subtotal to a management event.
ListIncidentSubtotals Query the subtotal of management events Query incident subtotals.
GetIncidentListByIdList Query management event details by event ID Queries the details of one or more incidents based on their IDs.
DeleteIncident Delete a management event Delete a management event.
CreateIncident Manually create a management event Manually create an incident.
DeliverIncident Change Owner of Management Event Change owner of a management event.
GetIncidentStatistics Management Event Statistics Management event statistics.
FinishIncident Complete Event Finishes an incident.
UpdateIncident Update management event Updates an incident.
RespondIncident Management event response Responds to an incident.
ListIncidentDetailTimelines Dynamic Details of Management Event This topic describes dynamic event details.
Similar events Similar events
GetIncidentSubtotalCount Obtain the subtotal quantity of similar management events Obtain the subtotal quantity of similar management events.
GetSimilarIncidentStatistics Similar Events List Lists similar incidents.

Alerts

API

Title

Description
ListTrendForSourceEvent Query alerting source trend statistics Query trend statistics for alert sources.
ListSourceEventsForMonitorSource Query the Recent Alert List Retrieves a list of recent alerts.
ListSourceEvents Query raw alert list Retrieve the list of original alerts.
GetEvent Query the most recent alert Query the most recent alert.

Incidents

API

Title

Description
GeneratePictureUploadSign Generate Image Upload Signature Information Generate image upload signature information.
ListProblemDetailOperations Incident Details Timeline Dynamic Fault Details.
UpdateProblemImprovement Update the details of post-incident review improvements Updates the review and improvement details for a problem.
ListSubscriptionServiceGroups List of fault collaboration groups This operation lists incident collaboration groups.
CreateProblem Problem upgrade A new fault has occurred.
CreateProblemMeasure Create a Fault Improvement Measure Creates an improvement measure for a problem.
CreateProblemSubtotal Add a subtotal note to a fault Add a subtotal note to a fault.
CreateProblemTimeline Create a fault timeline node Creates a problem timeline node.
CreateProblemTimelines Create time points in batch. Create time points in batch.
AddProblemServiceGroup Create an incident emergency collaboration group Adds a new problem emergency collaboration group.
UpdateProblem Update incident details Updates problem details.
UpdateProblemNotice Update fault notification Update fault notification.
UpdateProblemTimeline Update Fault Timeline Updates a problem timeline.
GenerateProblemPictureUploadSign Obtain signature information for uploading fault images Obtain signature information for uploading fault images.
ListProblemOperations Problem Dynamics Provides a dynamic list of faults.
ListProblems Query fault List Retrieve a list of problems.
ListProblemSubtotals List of fault summaries Lists problem subtotals.
CancelProblem Cancel a fault Fault cancellation.
FinishProblem Fault Resolution Completion Complete the fault resolution.
RecoverProblem Fault recovery Fault recovery.
ReplayProblem Incident postmortem Incident postmortem.
RevokeProblemRecovery Fault revocation and recovery Fault revocation and recovery.
GenerateProblemPictureLink Obtain the fault image links Obtain the fault image links.
UpdateProblemEffectionService Update the service impacted by an incident Update a service-impacting fault.
DeleteProblemEffectionService Delete the impact service Delete the impact service.
UpdateProblemMeasure Update fault improvement measures Updates an improvement measure for a problem.
DeleteProblem Delete a fault Delete a fault.
GetProblem Problem details Failure details.
GetProblemImprovement Fault Post-Mortem Improvement Details Details of post-incident reviews and improvements.
DeleteProblemMeasure Delete a fault improvement measure Delete a fault improvement measure.
DeleteProblemTimeline Delete a fault management event timeline edge zone Delete a fault management event timeline edge zone.
ListProblemTimeLines Query fault timeline list Queries the list of problem timelines.
GetProblemEffectionService Service Details of Impact Details of the services affected by the fault.
GetProblemPreview Get Fault Notification Preview Previews a problem notification.
RemoveProblemServiceGroup Remove the fault emergency collaboration group You can remove the Incident Response Collaboration Group.
CreateProblemEffectionService Create an impact service Create an impact service.

Global configuration

API

Title

Description
GetResourceStatistics Obtain Usage Summary Obtain Usage Summary.
ListConfigs Lookup table configuration Retrieve all dynamic lookup table configuration items.
ListDictionaries Enumeration dictionary API Enumeration dictionary API.
ListMonitorSources List of monitoring sources ListMonitorSources

Mobile application

API

Title

Description
CreateTenantApplication Create a mobile application Create a mobile application.
GetTenantApplication Mobile application details View mobile application details.

Business monitoring

API

Title

Description
PushMonitor API Integration Pushes and stores business monitoring data.

Upgrade plans

API

Title

Description
ListEscalationPlanServices List of selected scope objects for the upgrade plan List of selected scope objects (services) for the upgrade plan.
CreateEscalationPlan Create an escalation plan Create an escalation plan.
DeleteEscalationPlan Delete an upgrade plan Delete an upgrade plan.
DisableEscalationPlan Disable an upgrade plan Disable an upgrade plan.
EnableEscalationPlan Enable an escalation plan Enable an escalation plan.
GetEscalationPlan Escalation Plan Details Retrieve detailed information about a specified dynamic lookup table.
ListEscalationPlans Escalation Plan List Upgrade plans
UpdateEscalationPlan Update Escalation Plan Update the escalation plan.

Rich text

API

Title

Description
CreateRichText Create rich text Creates a rich text.
GetRichText Retrieve rich text information Retrieve rich text information.
UpdateRichText Update rich text Updates a rich text.

Others

API

Title

Description
ListIncidentDetailEscalationPlans List of escalation plans associated with the management event This section lists the escalation plans associated with the incident.
GetHomePageGuidance Query Home Page Configuration Guide Query homepage guidance configuration.
ListChartDataForServiceGroup Data Report chart Data API (service group) Data Report chart Data API (service group).
ListDataReportForUser Query personal management event statistics Query personal event statistics.
ListChartDataForUser Data Report Chart Data API (Personnel) Data Report chart Data API (Personnel).
GeneratePictureLink Generate Image Link Generate Image Link
RemoveIntegrationConfig Disassociate integration configuration Removes an integration configuration.
ListByMonitorSourceId List of monitoring association rules Monitoring association rules
ListRouteRulesByService Query Stream Rules by Service ID Queries the routing rules for a service.
GetTenantStatus Query the status of whether a tenant has enabled O&M Event Center. Queries the enablement status of the O&M Event Center for a tenant.
BillingStatistics Billing Display Billing display
DeleteServiceGroupScheduling DeleteServiceGroupScheduling Deletes a schedule.
ListEscalationPlansByNoticeObject ListEscalationPlansByNoticeObject Retrieves escalation plans associated with a specified notification object.
UnbindUser UnbindUser Unbinds a user.
ListRouteRulesByAssignWhoId ListRouteRulesByAssignWhoId Retrieves the routing rules for a specified assignment object.
ListServiceGroupsByUserId ListServiceGroupsByUserId Queries the service groups associated with a member ID.
CreateService Create a service Creates a service.
CreateSubscription Create Notification Subscription Create a notification subscription.
CreateUser Create a user Creates a user.
DeleteService Delete Service Delete a service.
DeleteSubscription Delete Notification Subscription Delete a notification subscription.
DeleteUser Delete User Delete a user.
DisableSubscription Disable notification subscription Disable notification subscription.
EnableSubscription Enable Notifications subscription Enable Notifications subscription.
GetIncident Management Event Details Event details.
GetService Query Service Details Queries the details of a service.
GetSubscription Notification subscription details Retrieve notification subscription details.
GetUser View user details View user details.
ListAlerts Alert list query Queries a list of alerts.
ListIncidents Event List Lists incidents.
ListIncidentTimelines Management Event Dynamics Event dynamics.
ListServices View Service List View the list of services.
ListSubscriptions Notifications Subscription List Lists notification subscriptions.
ListUsers User List User List.
UpdateService Update Service Updates a service.
UpdateSubscription Subscribe to Update Notifications Updates a notification subscription.
UpdateUser Update personnel information Updates user information.
Previous：API ReferenceNext：Endpoints