API标准及多语言预置SDK
本产品（SysOM/2023-12-30）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
巡检
|
API |
标题 |
API概述 |
| CreateInstanceInspection | 创建实例巡检 | 本接口用于创建SysOM实例巡检 |
告警推送
|
API |
标题 |
API概述 |
| ListAlertDestinations | 获取告警联系人列表 | 本接口用于获取告警联系人列表 |
| UpdateAlertDestination | 更新告警联系人 | 本接口用于更新告警联系人 |
| GetAlertDestination | 获取告警联系人 | 本接口用于获取制定告警联系人信息 |
| UpdateAlertEnabled | 更新告警策略状态 | 用户更新推送告警策略的状态 |
| GetAlertStrategy | 获取告警策略 | 根据策略id，获取用户的一条告警 |
| DeleteAlertStrategy | 删除告警策略 | 用户删除推送告警的策略 |
| ListAlertItems | 获取告警异常项列表 | 获取所有告警项 |
| ListAlertStrategies | 获取告警策略列表 | 用于获取用户所有推送告警的策略 |
| DeleteAlertDestination | 删除告警联系人 | 本接口用于删除告警联系人 |
| CreateAlertDestination | 创建告警联系人 | 本接口用于创建告警推送的联系人 |
| CreateAlertStrategy | 创建告警策略 | 新增推送告警的策略 |
| UpdateAlertStrategy | 更新告警策略 | 更新推送告警策略 |
热点分析
|
API |
标题 |
API概述 |
| UpdateFuncSwitchRecord | 更新服务功能模块配置 | 更新服务功能模块配置。 |
| GetServiceFuncStatus | 获取服务配置状态 | 获取功能模块配置 |
| GetHotSpotUniqList | 获取热点类型列表 | 获取实例下的某个字段列表。 |
| GetHotspotTracking | 获取热点追踪结果 | 获取热点追踪结果 |
| GetHotspotPidList | 获取pid列表 | 获取某个实例的pid列表 |
| GetHotspotInstanceList | 获取实例列表 | 获取热点实例列表 |
| GetHotspotCompare | 获取热点对比追踪结果 | 获取热点对比追踪结果 |
| GetHotspotAnalysis | 获取热点分析结果 | 获取热点分析结果 |
AI可观测
|
API |
标题 |
API概述 |
| StartAIAnalysis | 启动AI Infra观测 | 启动AI作业分析。 |
| GetListRecord | 获取AI Infra分析记录 | AI Infra获取分析记录列表 |
| GetAIQueryResult | 获取AI Infra观测结果 | 查看AI Infra分析结果 |
组件管理
|
API |
标题 |
API概述 |
| InstallAgentWithType | 安装组件 | 在指定的实例上安装 Agent |
| UninstallAgentWithType | 卸载组件 | 卸载指定版本的组件 |
| UpgradeAgentWithType | 更新组件 | 更新安装的组件的版本到指定版本 |
| GetResources | 获取集群/节点资源实时使用情况 | 获取集群/节点资源实时使用情况 |
| GetHostCount | 获取集群节点数量或节点Pod数量 | 获取集群节点数量或节点Pod数量 |
| InitialSysom | 开通Alinux控制台 | 初始化 SysOM，确保服务角色存在。 |
| ListClusters | 获取当前用户纳管集群列表 | 获取当前用户所有已纳管的集群 |
| ListPluginsInstances | 获取组件的实例列表 | 获取插件的安装/更新/卸载实例列表 |
| ListPodsOfInstance | 获取集群/实例中的Pod列表 | 获取集群或实例中的pod列表 |
| UpgradeAgentForCluster | 为 ACK 集群更新组件 | 给集群更新组件 |
| UpgradeAgent | 更新组件 | 更新安装的组件的版本到指定版本 |
| UninstallAgentForCluster | 为ACK集群卸载组件 | 给集群卸载组件 |
| UninstallAgent | 卸载组件 | 卸载指定版本的组件 |
| ListInstancesWithEcsInfo | 获取包含ECS信息的实例列表 | 获取已纳管/未纳管实例信息，信息中包含ECS信息 |
| ListInstanceStatus | 获取纳管实例状态 | 获取实例状态 |
| ListInstancesEcsInfoList | 获取实例的ecs信息的列表 | 获取ecs信息的列表，如标签列表，公网ip列表等 |
| ListClusterAgentInstallRecords | 获取 ACK 集群组件安装记录 | 获取集群组件安装记录 |
| ListAgentInstallRecords | 获取组件安装记录列表 | 列出 Agent 的安装记录 |
| InstallAgentForCluster | 为ACK集群安装组件 | 给集群安装组件 |
| InstallAgent | 安装组件 | 在指定的实例上安装 Agent |
| GetAgentTask | 获取组件任务的执行状态 | 获取Agent安装任务执行状态 |
| GetAgent | 获取组件详情 | 获取某个组件的详情 |
| ListAllInstances | 获取所有实例及其完整信息 | 此接口用于获取已纳管/未纳管实例列表并带有实例信息 |
健康度
|
API |
标题 |
API概述 |
| UpdateEventsAttention | 更新异常项关注度 | 异常项关注度更新，通过调整关注度影响异常项检测算法的敏感度。 |
| ListAbnormalyEvents | 获取异常事件详情 | 获取一定时间段内的集群/节点/Pod的异常事件信息 |
| ListInstanceHealth | 获取集群中节点/Pod的健康度列表 | 获取一定时间内集群节点/Pod健康度列表 |
| InvokeAnomalyDiagnosis | 异常项诊断发起 | 异常项诊断发起 |
| GetRangeScore | 获取健康分趋势 | 获取健康分趋势 |
| GetProblemPercentage | 获取异常问题占比 | 获取一定时间内集群中节点/节点中pod异常问题占比 |
| GetInstantScore | 获取实时集群/节点健康度分数 | 获取实时集群/节点健康度分数 |
| GetHealthPercentage | 获取节点/Pod健康状态占比 | 获取一段时间内节点/Pod健康状态占比 |
| GetAbnormalEventsCount | 获取异常事件的数量 | 获取节点/Pod不同等级未处理（未诊断）异常事件的数量 |
诊断
|
API |
标题 |
API概述 |
| ListDiagnosis | 获取诊断列表 | 获取诊断历史记录列表。 |
| GetDiagnosisResult | 获取诊断结果 | 获取诊断结果。 |
| InvokeDiagnosis | 发起诊断 | 发起诊断。 |
| AuthDiagnosis | 授权诊断 | 本接口用于授权 SysOM 对本账号下的 ECS 实例进行诊断，只有在调用本接口对特定的ECS进行授权后，才可以调用 InvokeDiagnosis 接口对其发起诊断。 |
OS copilot
|
API |
标题 |
API概述 |
| GetCopilotHistory | 获取copilot流式接口的聊天记录 | 获取copilot历史聊天记录 |
| GenerateCopilotStreamResponse | 请求os copilot服务流式sse接口 | 流式copilot服务接口 |
| GenerateCopilotResponse | 请求copilot服务 | 获取copilot服务的返回结果 |
其他
|
API |
标题 |
API概述 |
| CheckInstanceSupport | 检查实例是否支持 | 检查目标实例是否被 SysOM 支持 |
| StartAIDiffAnalysis | 启动AI Infra差分分析 | 启动AI Infra差分分析。 |
| CreateVmcoreDiagnosisTask | 创建宕机诊断任务 | 该接口创建一个宕机智能诊断任务，对参数输入的vmcore或者dmesg日志文件进行诊断。 |
| GetVmcoreDiagnosisTask | 查询诊断任务 | 该接口根据任务ID查询对应的任务执行状态和诊断结果。 |
| ListVmcoreDiagnosisTask | 查询宕机诊断列表 | 查询历史宕机诊断列表。 |
| CpuHighAgentStreamResponse | 请求CPU高agent流式sse接口 | cpu高agent流式接口 |
| CreateClusterVpcEndpointConnection | 创建集群VPC端点连接 | 创建集群Vpc端点连接 |
| DescribeMetricList | 查询指标数据 | 查询指标 |
| GetAifgResult | 获取诊断结果 | 获取诊断结果 |
| GetAifgUrl | 获取诊断结果url链接 | 获取诊断结果url链接 |
| GetConfigByName | 根据配置名称获得配置内容 | 根据配置名称获取配置信息 |
| GetGpuClusterArgsOptions | 获取GPU资源拓扑选项参数API | 获取GPU集群参数列表 |
| GetGpuClusterListAlarmRecord | 获取GPU资源拓扑异常事件列表 | 获取GPU集群告警列表 |
| GetGpuClusterTopology | 获取GPU资源拓扑API | 获取GPU集群拓扑 |
| GetInspectionReport | 获取巡检报告 | 本接口用于获取SysOM巡检报告 |
| GetListGpuCluster | 获取GPU集群列表 | 获取GPU集群列表 |
| ListAgents | 获取组件列表 | 获取 Agent 列表 |
| ListAifgJobs | 获取诊断任务列表 | 获取诊断任务列表。 |
| ListInstanceInfo | 获取实例信息列表 | 此接口用于获取某类型实例信息的所有值 |
| ListInstances | 获取纳管实例列表 | 获取实例列表 |
| ListRegions | 获取纳管实例分布的区域列表 | 列出所有纳管了机器的区域 |
| StartAifgAnalysis | 发起诊断 | 触发AI应用诊断 |