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 |
| CreateInstanceInspection | Create an instance inspection | Creates a SysOM instance inspection. |
Alert notification
|
API |
Title |
Description |
| ListAlertDestinations | Get alert contact list | Retrieves a list of alert contacts. |
| UpdateAlertDestination | Update an alert contact | Updates an alert contact. |
| GetAlertDestination | Retrieve 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 an alert policy | Retrieves an alert rule of a user by policy ID. |
| DeleteAlertStrategy | Delete an alert policy | Deletes an alert policy for push alerting. |
| ListAlertItems | Retrieve alert metric list | Retrieves all alert metrics. |
| ListAlertStrategies | Retrieve alert policy list | Retrieves all alert policies configured by the user for push notifications. |
| DeleteAlertDestination | Delete an alert contact | Deletes an alert contact. |
| CreateAlertDestination | Create an alert contact | Creates a contact for alert notifications. |
| CreateAlertStrategy | Create an alert policy | Creates an alert policy for push notifications. |
| 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 | Retrieve hot spot type list | Retrieves 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 | Retrieve instance list | Retrieves the list of hot spot instances. |
| GetHotspotCompare | Retrieve hot spot comparison trace results | Retrieves the results of a hot spot comparison trace. |
| GetHotspotAnalysis | Retrieve hot spot analysis results | Retrieves hot spot analysis results. |
AI observability
|
API |
Title |
Description |
| StartAIAnalysis | Start AI infra observation | Starts AI job analysis. |
| GetListRecord | Retrieve AI infra analysis records | Retrieves a list of AI Infra analysis records. |
| GetAIQueryResult | Retrieve AI infra observation results | Queries AI Infra analysis results. |
Component management
|
API |
Title |
Description |
| InstallAgentWithType | Install component | Installs an Agent on a specified instance. |
| UninstallAgentWithType | Uninstall a component | Uninstalls a specified version of a component. |
| UpgradeAgentWithType | Update a component | Updates the version of an installed component to a specified version. |
| 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 node Pods in a cluster. |
| InitialSysom | Activate the alinux console | Initializes SysOM to ensure that the service-linked role exists. |
| ListClusters | Query managed clusters for the current user | Retrieves all managed clusters for the current user. |
| ListPluginsInstances | Retrieve the instance list of a component | Retrieves the list of instances for plug-in installation, update, or uninstallation. |
| ListPodsOfInstance | Get pod list in a cluster or instance | Retrieves the list of pods in a cluster or instance. |
| UpgradeAgentForCluster | Update a component for an ACK cluster | Updates a component 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. |
| ListInstancesWithEcsInfo | Retrieve instance list with ECS information | Retrieves information about managed and unmanaged instances, including ECS information. |
| ListInstanceStatus | Retrieve managed instance status | Retrieves the instance status. |
| ListInstancesEcsInfoList | Retrieve ECS information lists for instances | Retrieves ECS information lists for instances, such as tag lists and public IP address lists. |
| ListClusterAgentInstallRecords | Retrieve ACK cluster component installation records | Retrieves the installation records of cluster components. |
| ListAgentInstallRecords | List component installation records | Lists the installation records of an Agent. |
| InstallAgentForCluster | Install a component on an ACK cluster | Installs a component on an ACK cluster. |
| InstallAgent | Install component | Installs an agent on a specified instance. |
| GetAgentTask | Retrieve the execution status of a component task | Retrieves the execution status of an Agent installation task. |
| GetAgent | Get component details | Retrieves the details of a specific component. |
| ListAllInstances | Retrieve all instances with complete information | Retrieves a list of managed or unmanaged instances along with their instance information. |
Health score
|
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 diagnosis | Initiates an anomaly diagnosis. |
| GetRangeScore | Retrieve health score trend | Retrieves the health score trend. |
| GetProblemPercentage | Retrieve anomaly issue proportion | Retrieves the proportion of anomaly issues for nodes in a cluster or pods in a node within a specified time range. |
| GetInstantScore | Retrieve real-time cluster/node health score | Retrieves the real-time health score of a cluster or node. |
| GetHealthPercentage | Retrieve node/pod health status distribution | Retrieves the health status distribution of nodes or pods over a specified time period. |
| GetAbnormalEventsCount | Retrieve abnormal event count | Retrieves the number of unprocessed (undiagnosed) abnormal events at different severity levels for a node or pod. |
Diagnostics
|
API |
Title |
Description |
| ListDiagnosis | Retrieve diagnostic list | Retrieves a list of diagnostic history records. |
| GetDiagnosisResult | Retrieve diagnostic results | Retrieves diagnostic results. |
| InvokeDiagnosis | Initiate a diagnostic task | Initiates a diagnostic task. |
| AuthDiagnosis | Authorize diagnostics | Authorizes SysOM to diagnose ECS instances under the current account. You must call this operation to authorize diagnostics on a specific ECS instance before you can call the InvokeDiagnosis operation to initiate diagnostics on it. |
OS copilot
|
API |
Title |
Description |
| GetCopilotHistory | Retrieve chat records from the copilot streaming API | Retrieves the historical chat records of Copilot. |
| GenerateCopilotStreamResponse | Request OS copilot streaming SSE service | Provides a streaming SSE interface for the OS Copilot service. |
| GenerateCopilotResponse | Request the copilot service | Retrieves the response result from the Copilot service. |
Others
|
API |
Title |
Description |
| CheckInstanceSupport | Check whether instances are supported | Checks whether target instances are supported by SysOM. |
| StartAIDiffAnalysis | Start AI infra differential analysis | Starts an AI Infra differential analysis. |
| CreateVmcoreDiagnosisTask | Create a breakdown diagnostic task | Creates an intelligent breakdown diagnostic node to diagnose the vmcore or dmesg log file specified in the input parameters. |
| GetVmcoreDiagnosisTask | Query a diagnostic task | Queries the execution status and diagnostic result of a diagnostic task by task ID. |
| ListVmcoreDiagnosisTask | Query down diagnosis list | Queries the list of historical down diagnosis tasks. |
| CpuHighAgentStreamResponse | Invoke CPU high agent streaming SSE interface | Invokes the CPU high agent streaming SSE interface. |
| CreateClusterVpcEndpointConnection | Create a cluster VPC endpoint connection | Creates a VPC endpoint connection for a cluster. |
| DescribeMetricList | Query metric data | Queries metric data. |
| GetAifgResult | Retrieve diagnostic results | Retrieves diagnostic results. |
| GetAifgUrl | Retrieve diagnostic result URL link | Retrieves the URL link of a diagnostic result. |
| GetConfigByName | Retrieve configuration content by configuration name | Retrieves configuration information by configuration name. |
| GetGpuClusterArgsOptions | Retrieve GPU resource topology option parameters | Retrieves the GPU cluster parameter list. |
| GetGpuClusterListAlarmRecord | Retrieve the list of GPU resource topology anomaly events | Retrieves the list of GPU cluster alerts. |
| GetGpuClusterTopology | Retrieve GPU resource topology | Retrieves the GPU cluster topology. |
| GetInspectionReport | Retrieve an inspection report | Retrieves a SysOM inspection report. |
| GetListGpuCluster | Retrieve GPU cluster list | Retrieves a list of GPU clusters. |
| ListAgents | Retrieve component list | Retrieves a list of Agents. |
| ListAifgJobs | Retrieve diagnostic task list | Retrieves a list of diagnostic tasks. |
| ListInstanceInfo | Retrieve instance information list | Retrieves all values of a specific type of instance information. |
| ListInstances | Retrieve managed instance list | Retrieves the list of managed instances. |
| ListRegions | List regions of managed instances | Lists all regions that contain managed instances. |
| StartAifgAnalysis | Trigger diagnostics | Triggers AI application diagnostics. |