# Alibaba Cloud System Operation&Maintenance API

> Alibaba Cloud System Operation&Maintenance API on Apizie: 98 endpoints (Authorizes SysOM to diagnose ECS instances under the current account. You must call this operation to…, Checks whether resources such as clusters and nodes support the current configuration, Checks whether target instances are supported by SysOM, Invokes the CPU high agent streaming SSE interface, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-sysom/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-sysom`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/sysom
- Page: https://zieapi.vercel.app/api/cloud/aliyun-sysom
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-sysom/openapi.json

Alibaba Cloud OpenAPI for System Operation&Maintenance (sysom, version 2023-12-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Authorizes SysOM to diagnose ECS instances under the current account. You must call this operation to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/auth-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| autoCreateRole | string | no | Specifies whether to enable automatic creation of the service-linked role |
| autoInstallAgent | string | no | Specifies whether to automatically install the latest version of the agent if it is not already installed |
| instances | array | no | The list of instances authorized for diagnostics |

### Checks whether resources such as clusters and nodes support the current configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/check-agent-config-supported` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | yes | The ID of the component to update. You can obtain the component ID from the ListAgents operation |
| configId | string | yes | The ID of the component configuration to install |
| checkType | string | no | The configuration dimension to check, such as cluster or node |
| instances | string | no | The list of instances. Separate multiple instance IDs with commas (,) |
| clusters | string | no | The cluster ID |
| content | string | no | The configuration content |

### Checks whether target instances are supported by SysOM
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/check-instance-support` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| instances | array | no | The list of instance IDs to check |
| region | string | no | The region to which the instances belong. Make sure that all instance IDs specified in instances belong to the same region |

### Invokes the CPU high agent streaming SSE interface
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/cpu-high-agent-stream-response` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| llmParamString | string | no | The input parameter for the CPU high agent service. Refer to the standard LLM API input parameter dict. Convert it to a string and pass it… |

### Creates a component configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/create-agent-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | yes | The ID of the component for the configuration. You can obtain the component ID from ListAgents |
| configName | string | yes | The name of the configuration |
| content | string | yes | The content of the configuration |

### Creates a contact for alert notifications
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/create-alert-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| app_id | string | no | The ID of the IM bot |
| app_secret | string | no | The secret key of the IM bot |
| group_id | array | no | The ID of the group |
| imbot | string | no | Specifies whether the IM bot is enabled |
| name | string | no | The name of the alert contact |
| params | object | no | The configuration parameters of the alert contact |
| source | string | no | The configuration source |
| target | string | no | The push target. Currently, only DingTalk bots are supported |

### Creates an alert push policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/create-alert-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| enabled | string | yes | Specifies whether the alert policy is enabled |
| k8sLabel | string | no | The Kubernetes label |
| name | string | yes | The alert policy name |
| strategy | object | yes | The details of the alert policy |

### Creates a VPC endpoint connection for a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/create-cluster-vpc-endpoint-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| clusterId | string | yes | The ACK cluster ID |
| dryRun | string | no | Specifies whether to perform a dry run |
| region | string | yes | The region to which the cluster belongs |

### Creates a SysOM instance inspection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/create-instance-inspection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| instance | string | no | The instance ID |
| items | array | no | The anomaly items |
| metricSource | string | no | The metric source |
| region | string | no | The region to which the instance belongs |
| source | string | no | The source |

### Creates an intelligent breakdown diagnostic node to diagnose the vmcore or dmesg log file specified in the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/create-vmcore-diagnosis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| debuginfoCommonUrl | string | no | The download URL of the debuginfo-common file. This parameter is optional when the diagnosis type is vmcore. For CentOS or Alinux kernel… |
| debuginfoUrl | string | no | The download URL of the debuginfo file. This parameter is optional when the diagnosis type is vmcore. For CentOS or Alinux kernel… |
| dmesgUrl | string | no | The download URL of the dmesg log file. This parameter is required when the diagnosis type is dmesg |
| taskType | string | yes | The task type. Valid values: vmcore: a vmcore file diagnostic task. dmesg: a dmesg log diagnostic task |
| vmcoreUrl | string | no | The download URL of the vmcore file. This parameter is required when the diagnosis type is vmcore |

### Deletes a component configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/delete-agent-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | no | The ID of the component associated with the configuration to delete |
| configId | string | no | The ID of the component configuration to delete |

### Deletes an alert contact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/delete-alert-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| id | integer | no | The ID of the alert contact |

### Deletes an alert policy for push alerting
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/delete-alert-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| id | string | yes | The ID of the alert policy |

### Queries metric data
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/describe-metric-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| instance | string | no | The instance ID |
| metricName | string | no | The metric name |
| startTime | integer | no | The start time. The value is a UNIX timestamp in seconds |
| endTime | integer | no | The end time. The value is a UNIX timestamp in seconds |

### Retrieves the response result from the Copilot service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/generate-copilot-response` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| llmParamString | string | no | The input parameter for the Copilot LLM service. Refer to the standard LLM API input parameter dict, convert it to a string, and pass it… |

### Provides a streaming SSE interface for the OS Copilot service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/generate-copilot-stream-response` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| llmParamString | string | no | The input parameter for the Copilot LLM service. Refer to the standard LLM interface input parameter dict. Convert the dict to a string… |

### Queries AI Infra analysis results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-aiquery-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| analysisId | string | no | The AI analysis ID |

### Retrieves the number of unprocessed (undiagnosed) abnormal events at different severity levels for a node or…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-abnormal-events-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |
| pod | string | no | The pod name |
| namespace | string | no | The namespace of the pod |
| start | number | no | The start time |
| end | number | no | The end time |
| showPod | integer | no | Specifies whether to display abnormal events of the pod |
| level | string | no | The severity level of the abnormal event |

### Retrieves the details of a specific component
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agent_id | string | no | The component ID |

### Retrieves component configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-agent-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | yes | The ID of the component for which you want to retrieve configurations |
| configName | string | no | The name of the configuration |
| configId | string | no | The ID of the component configuration to retrieve |
| current | string | no | The current page number. This field is available when page-based pagination is used |
| pageSize | string | no | The number of entries to return on each page. Default value: 10 |
| region | string | no | The region ID |

### Retrieves the execution status of an Agent installation task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-agent-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| task_id | string | no | The task ID |

### Retrieves the diagnostic results
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-aifg-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| taskId | string | yes | The task identifier |

### Retrieves the URL for diagnostic results
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-aifg-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| taskId | string | yes | The task identifier |

### Retrieves the information of a specified alert contact
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-alert-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| id | integer | no | The alert contact ID |

### Retrieves an alert policy for a user based on the policy ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-alert-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| id | integer | no | The policy ID |

### Retrieves configuration information by configuration name
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-config-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| versionId | integer | no | The version ID |
| configName | string | yes | The configuration name |
| entityId | string | no | The entity ID. Default value: "default" |
| configType | string | yes | The type of the configuration parameter |
| useGlobalUid | string | no | Specifies whether to use a global UID |

### Retrieves the historical chat records of Copilot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-copilot-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| count | integer | yes | The number of historical chat records to request, generally fewer than 100 |

### Queries the hotfixes and compatible packages for a CVE
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-cve-hotfix` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cveIds | array | yes | The list of CVE IDs |
| kernelVersions | array | no | The list of full kernel versions |

### Retrieves diagnostic results
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-diagnosis-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| task_id | string | yes | The diagnostic task ID |

### Retrieves the list of parameters for a GPU cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-gpu-cluster-args-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| filterType | string | yes | Query cluster machine list scenario: Set the retrieval type to comm_instance_id_list or instance_id_list. comm_instance_id_list: Retrieves… |
| filterValues | string | no | The filter conditions, which is a JSON object. The cluster_id field is required. Other filter conditions support the following values:… |

### Retrieves the list of GPU cluster alerts
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-gpu-cluster-list-alarm-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| alarmTime | string | no | The specific time or time range to query. Specify a specific time, such as "2025-08-22 18:16:25". To specify a time range, use the… |
| alarmCluster | string | no | The cluster to query. Specify a cluster, such as "cluster1". To query multiple clusters, separate them with commas, such as… |
| alarmTask | string | no | The task to query. Specify a task, such as "task1". To query multiple tasks, separate them with commas, such as "task1,task2,task3" |
| current | integer | yes | The current page number for pagination |
| pageSize | integer | yes | The number of entries per page for pagination |
| status | string | no | The task status used to filter results. Valid values: blocking, running, exited, and restart |
| alarmType | string | no | The anomaly type used to filter results, such as GPU memory access out of bounds or task hang |
| alarmExtInfo | string | no | The instance ID or container used to filter anomalies |

### Retrieves the topology of a GPU cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-gpu-cluster-topology` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| clusterId | string | yes | The name of the cluster. You can select a cluster from the cluster list obtained by calling the GetListGpuCluster operation |
| startTime | string | no | The query timestamp. Default value: the current time. The timestamp must be accurate to seconds |
| instanceIdList | string | no | The list of instances for which to query GPU topology information |
| podList | string | no | The list of pods for which to query GPU topology information |
| taskIdList | string | no | The list of tasks for which to query GPU topology information |
| communicationId | string | no | The ID of the communication group. Used to view the collective communication topology and the topology relationships of a specified… |
| channelId | string | no | The ID of the channel. Used to view the collective communication topology and the topology relationships of a specified channel ID under a… |
| topoType | string | no | The topology type. Used to view the collective communication topology and the topology relationships of a specified topology type under a… |

### Retrieves the health status distribution of nodes or pods over a specified time period
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-health-percentage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |
| start | number | yes | The start time |
| end | number | yes | The end time |

### Retrieves the number of nodes or node Pods in a cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-host-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |
| start | number | no | The start time |
| end | number | no | The end time |

### Retrieves the list of a specific field under an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-hot-spot-uniq-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| beg_end | integer | yes | The end time |
| beg_start | integer | yes | The start time |
| instance | string | yes | The instance ID |
| pid | integer | no | The process ID |
| table | string | no | The table name |
| uniq | string | yes | The identifier flag |

### Queries the status of an asynchronous task for CVE hotfixes on a node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-hotfix-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| taskId | string | yes | The ID of the asynchronous task |

### Retrieves hot spot analysis results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-hotspot-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| appType | string | yes | The application type |
| beg_end | integer | yes | The end time |
| beg_start | integer | yes | The start time |
| instance | string | yes | The instance ID |
| pid | integer | no | The process PID |
| table | string | no | The name of the table to query |

### Retrieves the results of a hot spot comparison trace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-hotspot-compare` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| beg1_end | integer | yes | The end time 1 |
| beg1_start | integer | yes | The start time 1 |
| beg2_end | integer | yes | The end time 2 |
| beg2_start | integer | yes | The start time 2 |
| hot_type | string | no | The hot spot type |
| instance1 | string | yes | The instance 1 |
| instance2 | string | yes | The instance 2 |
| pid1 | integer | no | The process of instance 1 |
| pid2 | integer | no | The process of instance 2 |
| table | string | yes | The name of the table to query |

### Retrieves the list of hot spot instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-hotspot-instance-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| beg_end | integer | yes | The end time |
| beg_start | integer | yes | The start time |
| table | string | yes | The name of the table to query |

### Retrieves the PID list of a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-hotspot-pid-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| beg_end | integer | yes | The end time |
| beg_start | integer | yes | The start time |
| instance | string | yes | The instance ID |
| table | string | yes | The name of the table to query |

### Retrieves hot spot tracking results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-hotspot-tracking` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| beg_end | integer | yes | The end time |
| beg_start | integer | yes | The start time |
| hot_type | string | yes | The hot spot type |
| instance | string | yes | The instance ID |
| pid | integer | no | The process PID |
| table | string | yes | The name of the table to query |

### Retrieves a SysOM inspection report
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-inspection-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| reportId | string | no | The inspection report ID |

### Retrieves the real-time health score of a cluster or node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-instant-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |

### Queries the list of GPU clusters
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-list-gpu-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| timeRegion | string | no | The time range to query. Unit: milliseconds. Format: [start,end]. Example: [13254125000, 52451241000] |
| regionId | string | no | The ID of the region to query |

### Retrieves a list of AI Infra analysis records
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-list-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number |
| pageSize | integer | no | The number of entries per page |
| region | string | no | The region ID |
| customId | integer | no | The customId |
| analysisId | string | no | The ID of the specified analysis record |

### Retrieves the proportion of anomaly issues for nodes in a cluster or pods in a node within a specified time…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-problem-percentage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |
| start | number | yes | The start time |
| end | number | yes | The end time |

### Retrieves the health score trend
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-range-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |
| start | number | yes | The start time |
| end | number | yes | The end time |

### Retrieves the real-time resource usage of a cluster or node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |
| type | string | no | The resource type |

### Retrieves the configuration of a feature module
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-service-func-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| params | string | yes | The diagnostic parameters. Different types of diagnostics require different diagnostic parameters. You can use this field to filter… |
| service_name | string | yes | The service name |
| channel | string | yes | The channel name |

### Queries the execution status and diagnostic result of a diagnostic task by task ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/get-vmcore-diagnosis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| taskId | string | yes | The task ID |

### Initializes SysOM to ensure that the service-linked role exists
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/initial-sysom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| check_only | string | no | Specifies whether to only check whether the service-linked role exists |
| source | string | no | The source. Set the value to console |

### Installs an agent on a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/install-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agent_id | string | yes | The ID of the component to install |
| agent_version | string | yes | The version of the component to install |
| install_type | string | yes | The installation type. Valid values: InstallAndUpgrade: installs the component if it does not exist, or updates it if it exists.… |
| instances | array | yes | The list of instances on which to install the component |

### Installs a component on an ACK cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/install-agent-for-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agent_id | string | no | The component ID |
| agent_version | string | no | The component version |
| cluster_id | string | no | The cluster ID. Pass the ID of the ACK cluster for this parameter |
| config_id | string | no | The component configuration ID |
| grayscale_config | string | no | The canary release environment |

### Installs an Agent on a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/install-agent-with-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| Tag | array | no | The Tag |
| agentId | string | yes | The ID of the component to install |
| agentVersion | string | yes | The version of the component to install |
| configId | string | no | The configuration ID of the component to install |
| instanceType | string | yes | The instance type |
| instances | array | yes | The list of instances on which to install the component |

### Installs CVE hotfixes asynchronously on specified instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/install-hotfix` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cveId | string | yes | CVE ID |
| instances | array | yes | The target instances |

### Initiates an anomaly diagnosis
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/invoke-anomaly-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| uuid | string | no | The UUID of the anomaly event |

### Initiates a diagnostic task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/invoke-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| channel | string | yes | The diagnostic channel. Currently fixed to the ECS channel |
| params | string | yes | The diagnostic parameters. Different diagnostic types require different parameters. For the parameters required by each diagnostic type,… |
| service_name | string | yes | The diagnostic type. Specifies the type of diagnostic to perform |

### Retrieves anomaly event information for a cluster, node, or pod within a specified time range
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-abnormaly-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |
| start | number | no | The start time |
| pod | string | no | The pod name |
| namespace | string | no | The namespace of the pod |
| end | number | no | The end time |
| level | string | no | The level of the anomaly event |
| showPod | integer | no | Specifies whether to display anomaly events of the pod |
| current | integer | no | The current page number. This field exists when pagination is used |
| pageSize | integer | no | The number of entries per page. Default value: 5. Valid values: 1 to 100 |
| event | string | no | The name of the anomaly event |

### Lists the installation records of an Agent
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-agent-install-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number. Pages start from page 1 |
| pageSize | integer | no | The number of entries per page |
| instance_id | string | no | The instance ID. If you specify this parameter, only the Agent installation records for the specified instance are returned |
| plugin_id | string | no | The Agent ID. If you specify this parameter, only the installation records for the specified Agent are returned. You can use this… |
| plugin_version | string | no | The Agent version. This parameter cannot be used alone. Use it together with the plugin_id parameter to filter the installation records… |
| status | string | no | The status used to filter component installation records |
| region | string | no | The region ID |

### Retrieves a list of Agents
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-agents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number. Pages start from page 1 |
| pageSize | integer | no | The number of entries per page |
| name | string | no | Filters plug-ins by plug-in name |
| type | string | no | Filters the list by Agent type. For example, set this parameter to control to retrieve all Agents of the control type |

### Retrieves the list of diagnostic tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-aifg-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | yes | The current page number |
| pageSize | integer | yes | The number of entries per page |
| serviceName | string | yes | The diagnostic service name |
| nextToken | string | no | The pagination cursor. A non-empty value indicates that more data is available |
| maxResults | integer | no | The maximum number of records to retrieve at a time |
| region | string | no | The region ID |

### Retrieves a list of alert contacts
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-alert-destinations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| name | string | no | The name of the alert contact |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| nextToken | string | no | The pagination token for the next request |
| current | integer | no | The current page number (starting from 1) |
| pageSize | integer | no | The number of records per page |

### Retrieves all alert metrics
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-alert-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |

### Retrieves all alert notification policies for the user
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-alert-strategies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| maxResults | integer | no | The maximum number of records to retrieve per request |
| nextToken | string | no | The pagination token for the next request |
| current | integer | no | The current page number, starting from 1 |
| pageSize | integer | no | The number of entries per page |
| name | string | no | The Policy Name of the alerting policy |

### Queries a list of managed and unmanaged instances along with their details
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-all-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| region | string | no | The region ID |
| instanceType | string | no | The instance type |
| managedType | string | no | The management type |
| filters | string | no | The list of filters |
| current | string | no | The current page number |
| pageSize | string | no | The number of entries to return on each page. Default value: 10 |
| pluginId | string | no | The plugin ID |
| maxResults | integer | no | The maximum number of records to return in a single request |
| nextToken | string | no | The pagination cursor. If this parameter is not empty, it indicates that more data is available |

### Retrieves the installation records of cluster components
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-cluster-agent-install-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number, starting from 1 |
| pageSize | integer | no | The number of entries per page |
| cluster_id | string | no | Filters by cluster ID. This cluster ID is not the ACK cluster ID. It is the `cluster_id` field in the data returned by this operation, or… |
| plugin_id | string | no | Filters the installation list by the specified agent. You can use this parameter together with the plugin_version parameter |
| plugin_version | string | no | This parameter cannot be used alone and must be used together with the plugin_id parameter to filter the installation list by the… |
| agent_config_id | string | no | The component configuration ID |

### Retrieves all managed clusters for the current user
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number (starting from page 1) |
| pageSize | integer | no | The number of entries per page |
| name | string | no | The name of the plug-in used to filter plug-ins |
| cluster_id | string | no | The cluster ID used to filter clusters. This cluster ID is not the ACK cluster ID. It is the `id` field returned by this operation |
| cluster_status | string | no | `Running`: The cluster is managed normally. `Installing`: An installation task is in progress for the cluster. `Uninstalling`: An… |
| cluster_type | string | no | `ACK`: ACK cluster. `CUSTOM`: Custom cluster. The default cluster belongs to the custom cluster type |
| id | string | no | [Deprecated] Use the cluster_id parameter to filter clusters |

### Retrieves a list of diagnostic history records
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number |
| pageSize | integer | no | The number of entries per page |
| service_name | string | no | The diagnostic type |
| params | string | no | The diagnostic parameters. Different diagnostic types require different diagnostic parameters. You can use this field to filter records… |
| status | string | no | The execution status of the diagnostic task. Valid values: Ready: Ready. Running: Running. Success: Succeeded. Fail: Failed |

### Retrieves the health status list of cluster nodes or pods within a specified time range
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-instance-health` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cluster | string | no | The cluster ID |
| instance | string | no | The instance ID |
| start | number | yes | The start time |
| end | number | yes | The end time |
| current | integer | no | The current page number |
| pageSize | integer | no | The number of entries per page. Default value: 5. Valid values: 1 to 100 |

### Retrieves all values of a specific type of instance information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-instance-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| region | string | no | The region ID |
| infoType | string | no | The information type |
| managedType | string | no | The managed type |
| pluginId | string | no | The plugin ID |
| instanceType | string | no | The instance type |
| maxResults | integer | no | The number of entries per page |
| nextToken | string | no | The pagination token |

### Retrieves the instance status
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-instance-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number (starting from 1). This field is present when pagination is used |
| pageSize | integer | no | The number of entries per page. Default value: 10 |
| instance | string | no | The instance ID |
| status | string | no | The instance status used to filter the instance list. If this parameter is specified, only instances in the specified status are returned |
| region | string | no | The region ID |

### Retrieves the list of managed instances
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number. This field is present when pagination is used |
| pageSize | integer | no | The number of entries per page. Default value: 20. Valid values: 1 to 100 |
| instance | string | no | The ECS instance ID used to filter results |
| status | string | no | Filters instances by status |
| region | string | no | Filters instances by region |
| cluster_id | string | no | The cluster ID |

### Retrieves ECS information lists for instances, such as tag lists and public IP address lists
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-instances-ecs-info-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| region | string | yes | The region used to filter instances |
| info_type | string | yes | The type of information to retrieve |
| managed_type | string | no | The management status of the instance |
| instance_id | string | no | Specifies the instance ID to filter the Agent installation status of the specified instance |
| plugin_id | string | no | Specifies the component ID to filter the instance information list for the corresponding component |

### Retrieves information about managed and unmanaged instances, including ECS information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-instances-with-ecs-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| region | string | yes | Filters instances by region |
| instance_id | string | no | Specifies the instance ID to filter the Agent installation status of the specified instance |
| instance_name | string | no | The name of the component instance |
| instance_id_name | string | no | Filters instances by instance name or instance ID. Fuzzy match is supported |
| is_managed | integer | no | Filters instances by managed status |
| instance_tag | string | no | Filters instances by instance tag (JSON-encoded) |
| public_ip | string | no | Filters instances by public IP address |
| private_ip | string | no | Filters instances by private IP address |
| resource_group_name | string | no | Filters instances by resource group name |
| resource_group_id | string | no | Filters instances by resource group ID |
| resource_group_id_name | string | no | Filters instances by resource group name or resource group ID. Fuzzy match is supported |
| health_status | string | no | Filters instances by health status |
| os_name | string | no | Filters instances by operating system name |
| current | integer | no | The page number for pagination. This field indicates the current page |
| pageSize | integer | no | The number of entries per page. Default value: 10 |

### Retrieves the list of instances for plug-in installation, update, or uninstallation
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-plugins-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| operation_type | string | yes | Filters instances by plug-in installation status |
| plugin_id | string | yes | Specifies the agent ID to filter the instance list for the specified agent |
| region | string | yes | Filters instances by region |
| instance_id_name | string | no | Filters instances by instance ID or instance name. Fuzzy match is supported |
| instance_tag | string | no | Filters instances by instance tag |
| current | integer | no | The page number for paginated queries. This field indicates the current page |
| pageSize | integer | no | The number of entries per page. Default value: 10 |

### Retrieves the list of pods in a cluster or instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-pods-of-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| current | integer | no | The current page number (starting from 1) |
| pageSize | integer | no | The number of entries per page. Default value: 10 |
| cluster_id | string | no | The cluster identifier |
| instance | string | no | The instance ID |

### Lists all regions with managed instances
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |

### Queries the list of historical down diagnosis tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/list-vmcore-diagnosis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| days | integer | yes | The number of past days for which to query tasks. Maximum value: 30 |

### Asynchronously queries the CVE hotfix status on specified instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/query-hotfix-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cveId | string | yes | CVE ID |
| instances | array | yes | The target instances |

### Starts AI job analysis
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/start-aianalysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| analysisTool | string | no | The analysis tool. This parameter does not need to be specified when you call this operation by using OpenAPI |
| analysis_params | array | no | The data richness |
| channel | string | no | The channel name |
| comms | string | no | The process name. This parameter is optional |
| created_by | string | no | The creator. This parameter does not need to be specified when you call this operation by using OpenAPI |
| instance | string | no | The instance ID |
| instance_type | string | no | The instance type. This parameter does not need to be specified when you call this operation by using OpenAPI |
| iteration_func | string | no | The iteration entry function. This parameter is required only in iteration mode and can be left empty |
| iteration_mod | string | no | The iteration entry module. This parameter is required only in iteration mode and can be left empty |
| iteration_range | array | no | The iteration range. The iteration count refers to the number of iterations when the data collection module is activated, which is… |
| pids | string | no | The process IDs (PIDs) of the AI job. Multiple PIDs are supported and separated by commas (,) |
| region | string | no | The region ID |
| timeout | integer | no | The AI Infra analysis duration. Unit: milliseconds. Default value: 2000 |
| uid | string | no | The Alibaba Cloud account ID. This parameter does not need to be specified when you call this operation by using OpenAPI |

### Starts an AI Infra differential analysis
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/start-aidiff-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| task1 | object | yes | The task1 parameters |
| task2 | object | yes | The task2 parameters |

### Triggers AI application diagnostics
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/start-aifg-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| channel | string | yes | The channel type |
| params | string | yes | The additional information |
| region | string | yes | The region information |
| serviceName | string | yes | The service name |

### Uninstalls a specified version of a component
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/uninstall-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agent_id | string | yes | The ID of the component to uninstall |
| agent_version | string | yes | The version of the component to uninstall |
| instances | array | yes | The list of instances from which to uninstall the component |

### Uninstalls a component from a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/uninstall-agent-for-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agent_id | string | no | The component ID |
| agent_version | string | no | The component version |
| cluster_id | string | no | The cluster ID. This parameter must be set to the ID of an ACK cluster |

### Uninstalls a specified version of a component
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/uninstall-agent-with-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | yes | The ID of the component to uninstall |
| agentVersion | string | yes | The version of the component to uninstall |
| instanceType | string | no | The instance type |
| instances | array | yes | The list of instances from which to uninstall the component |

### Asynchronously uninstalls CVE hotfixes from the specified instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/uninstall-hotfix` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| cveId | string | yes | CVE ID |
| instances | array | yes | The target instances |

### Updates the component configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/update-agent-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | yes | The ID of the component whose configuration you want to update |
| configId | string | yes | The ID of the component configuration to update |
| content | string | yes | The new content of the component configuration |

### Updates an alert contact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/update-alert-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| app_id | string | no | The app ID of the chatbot |
| app_secret | string | no | The app secret of the chatbot |
| group_id | array | no | The group ID |
| id | string | no | The ID of the alert contact |
| imbot | string | no | Specifies whether the contact is an IM chatbot |
| name | string | no | The name of the alert contact |
| params | object | no | The configuration parameters |
| source | string | no | The configuration source |
| target | string | no | The alert push target. Currently, only DingTalk contacts are supported |

### Updates the status of a push alert policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/update-alert-enabled` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| enabled | string | no | Specifies whether the alert policy is enabled |
| id | integer | no | The ID of the alert policy |

### Updates the alert push policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/update-alert-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| enabled | string | yes | Specifies whether the alert policy is enabled |
| id | integer | yes | The ID of the alert policy |
| k8sLabel | string | no | The Kubernetes label |
| name | string | yes | The alert policy name |
| strategy | object | yes | The details of the alert policy |

### Updates the configuration of a cluster component
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/update-cluster-agent-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | yes | The ID of the component whose configuration is to be updated |
| clusterId | string | yes | The ID of the cluster. You can call the ListClusters operation to obtain the cluster ID |
| configId | string | yes | The ID of the component configuration to install on the cluster |

### Updates the attention level of an anomaly item. Adjusting the attention level affects the sensitivity of the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/update-events-attention` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| mode | integer | no | The sensitivity of the anomaly event. Valid values: -1 to 3. A value of -1 indicates that the sensitivity is decreased by 1. A value of 0… |
| range | string | no | The scope in which the update takes effect. Valid values: cluster and node |
| uuid | string | yes | The UUID of the anomaly event |

### Updates the configuration of a service feature module
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sysom/update-func-switch-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| params | string | yes | The diagnostic parameters. Different types of diagnostics require different diagnostic parameters. You can use this field to filter… |
| service_name | string | yes | The service name |
| channel | string | yes | The diagnostic channel. Currently, this parameter is fixed to the ECS channel |

### Updates the component configuration of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/update-instance-agent-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | yes | The ID of the component whose configuration is to be updated |
| configId | string | yes | The ID of the component configuration to be applied to the instance |
| instances | array | no | The instance information |

### Updates an installed component to a specified version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/upgrade-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agent_id | string | yes | The ID of the component to update |
| agent_version | string | yes | The version to which the component is updated |
| instances | array | yes | The list of instances on which to update the component |

### Updates a component for a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/upgrade-agent-for-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agent_id | string | no | The component ID |
| agent_version | string | no | The component version |
| cluster_id | string | no | The cluster ID. Pass the ID of the ACK cluster for this parameter |

### Updates the version of an installed component to a specified version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/upgrade-agent-with-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |
| agentId | string | yes | The ID of the component to update |
| agentVersion | string | yes | The version to which the component is updated |
| instanceType | string | no | The instance type |
| instances | array | yes | The list of instances on which to update the component |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sysom.cn-hangzhou.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-sysom/auth-diagnosis" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud System Operation&Maintenance API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-sysom/auth-diagnosis with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud System Operation&Maintenance API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud System Operation&Maintenance itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud System Operation&Maintenance API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-sysom.

### What is the status of the Alibaba Cloud System Operation&Maintenance API?
Needs your own provider key (bring your own key)