API standards and multilingual preset SDKs
The OpenAPI of this product (SysOM/2023-12-30) 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.
Inspection
|
API |
Title |
Description |
| GetInspectionReport | Retrieve an inspection report | Retrieves a SysOM inspection report. |
| CreateInstanceInspection | CreateInstanceInspection | Creates a SysOM instance inspection |
Alert notification
|
API |
Title |
Description |
| ListAlertDestinations | Get Alert Contact List | This API is used to get the list of alert contacts |
| UpdateAlertDestination | Update an alert contact | Updates an alert contact. |
| GetAlertDestination | Get alert contact | Retrieves the information of a specified alert contact. |
| UpdateAlertEnabled | Update alert policy status | Updates the status of a push alert policy. |
| GetAlertStrategy | Retrieve alert policy | Retrieves an alert for a user based on the policy ID. |
| DeleteAlertStrategy | Delete alert policy | Deletes an alert policy for push notifications. |
| ListAlertItems | Retrieve alert metric list | Retrieves all alert metrics. |
| ListAlertStrategies | Get alert policy list | Retrieves all push alert policies for the current user. |
| DeleteAlertDestination | Delete an alert contact | Deletes an alert contact. |
| CreateAlertDestination | Create alert contact | Creates a contact for alert notifications. |
| CreateAlertStrategy | CreateAlertStrategy | Creates an alert push strategy. |
| UpdateAlertStrategy | Update alert policy | Updates a push alert policy. |
Hotspot analysis
|
API |
Title |
Description |
| UpdateFuncSwitchRecord | Update service feature module configuration | Updates the configuration of a service feature module. |
| GetServiceFuncStatus | Retrieve service configuration status | Retrieves the configuration of a feature module. |
| GetHotSpotUniqList | Get Hotspot Type List | Get the list of a specific field under an instance. |
| GetHotspotTracking | Retrieve hot spot tracking results | Retrieves hot spot tracking results. |
| GetHotspotPidList | Retrieve PID list | Retrieves the PID list of a specified instance. |
| GetHotspotInstanceList | Get Instance List | Get Hotspot Instance List |
| GetHotspotCompare | Get Hotspot Comparison Tracing Results | Get Hotspot Comparison Tracing Results |
| GetHotspotAnalysis | Retrieve hot spot analysis results | Retrieves hot spot analysis results. |
AI observability
|
API |
Title |
Description |
| StartAIAnalysis | Start AI Infra Observation | Start AI job analysis. |
| GetListRecord | Retrieve AI infra analysis records | Retrieves the list of AI Infra analysis records. |
| GetAIQueryResult | Retrieve AI infra observation results | Queries the AI Infra analysis results. |
Component management
|
API |
Title |
Description |
| GetResources | Retrieve real-time resource usage of a cluster or node | Retrieves the real-time resource usage of a cluster or node. |
| GetHostCount | Retrieve cluster node count or node pod count | Retrieves the number of nodes or the number of Pods on nodes in a cluster. |
| InitialSysom | Activate the alinux console | Initializes SysOM to ensure that the service-linked role exists. |
| ListClusters | Retrieve the managed cluster list of the current user | Retrieve all managed clusters of the current user |
| ListInstances | Retrieve managed instance list | Retrieves a list of instances. |
| ListPluginsInstances | Retrieve instance list of a component | Retrieves the list of instances for plug-in installation, update, or uninstallation. |
| ListPodsOfInstance | Retrieve pod list in a cluster or instance | Retrieves the list of pods in a cluster or instance. |
| UpgradeAgentForCluster | Update components for an ACK cluster | Updates components for a cluster. |
| UpgradeAgent | Update a component | Updates an installed component to a specified version. |
| UninstallAgentForCluster | Uninstall a component from an ACK cluster | Uninstalls a component from a cluster. |
| UninstallAgent | Uninstall a component | Uninstalls a specified version of a component. |
| ListRegions | List regions of managed instances | Lists all regions that contain managed instances. |
| ListInstancesWithEcsInfo | Retrieve instance list with ECS information | Retrieves information about managed and unmanaged instances, including ECS information. |
| ListInstanceStatus | Retrieve managed instance status | Retrieves instance statuses. |
| ListInstancesEcsInfoList | Retrieve ECS information lists for instances | Retrieves lists of ECS information for instances, such as tag lists and public IP address lists. |
| ListClusterAgentInstallRecords | Get ACK cluster component installation records | Get cluster component installation records |
| ListAgentInstallRecords | List component installation records | Lists the installation records of an Agent. |
| InstallAgentForCluster | Install Component for ACK Cluster | Install component for cluster |
| InstallAgent | Install component | Installs an Agent on a specified instance. |
| ListAgents | Retrieve component list | Retrieves a list of agents. |
| GetAgentTask | Retrieve the execution status of a component task | Retrieves the execution status of an Agent installation task. |
| GetAgent | Get Agent Details | Get details of a specific agent |
| ListAllInstances | Get all instances and their complete information | This API is used to retrieve a list of managed/unmanaged instances along with their instance information. |
Health status
|
API |
Title |
Description |
| UpdateEventsAttention | Update anomaly item attention level | Updates the attention level of an anomaly item. Adjusting the attention level affects the sensitivity of the anomaly detection algorithm. |
| ListAbnormalyEvents | Retrieve anomaly event details | Retrieves anomaly event information for a cluster, node, or pod within a specified time range. |
| ListInstanceHealth | Retrieve health status list of nodes or pods in a cluster | Retrieves the health status list of cluster nodes or Pods within a specified time range. |
| InvokeAnomalyDiagnosis | Initiate anomaly diagnostics | Initiates an anomaly diagnostics task. |
| GetRangeScore | Retrieve health score trend | Retrieves the health score trend. |
| GetProblemPercentage | Get Abnormal Problem Percentage | Get the proportion of abnormal issues in cluster nodes/pods within a specified time range |
| GetInstantScore | Get real-time cluster/node health score | Get real-time cluster/node health score |
| GetHealthPercentage | Retrieve node/pod health status distribution | Retrieves the health status distribution of nodes or pods over a specified time period. |
| GetAbnormalEventsCount | Obtain the Quantity of Anomalous Activity | Obtain the quantity of unprocessed (undiagnosed) anomalous activity at different Levels for edge zones/pods. |
Diagnostics
|
API |
Title |
Description |
| ListDiagnosis | Get Diagnostic List | Obtain the list of diagnostic history. |
| GetDiagnosisResult | Get Diagnosis Results | Get diagnosis results. |
| InvokeDiagnosis | Initiate Diagnosis | Initiate Diagnosis. |
| AuthDiagnosis | Authorize diagnosis | Authorizes SysOM to diagnose ECS instances under the current account. You must call this operation to authorize specific ECS instances before you can call the InvokeDiagnosis operation to initiate diagnostics on them. |
OS copilot
|
API |
Title |
Description |
| GetCopilotHistory | Retrieve chat history of the copilot streaming interface | Retrieves the chat history of Copilot. |
| GenerateCopilotStreamResponse | Call the OS copilot streaming SSE endpoint | Calls the streaming SSE endpoint of the OS Copilot service. |
| GenerateCopilotResponse | Request copilot service | Get the response result of the copilot service |
Others
|
API |
Title |
Description |
| CheckInstanceSupport | Check whether an instance is supported | Checks whether a target instance is supported by SysOM. |
| StartAIDiffAnalysis | Start AI infra differential analysis | Starts an AI Infra differential analysis. |
| DescribeMetricList | Query metric data | Queries metric data. |
| CreateVmcoreDiagnosisTask | Create a breakdown diagnostic task | Creates an intelligent breakdown diagnostic node that diagnoses the specified vmcore or dmesg log file based on the input parameters. |
| GetVmcoreDiagnosisTask | Query a diagnostic task | Queries the execution status and diagnostic result of a diagnostic task by task ID. |
| ListVmcoreDiagnosisTask | Query crash diagnosis task list | Query the historical crash diagnosis task list. |
| CpuHighAgentStreamResponse | Call CPU high agent streaming SSE interface | Calls the CPU High Agent streaming SSE interface. |