找不到 API ? 点击 反馈吧
- 热点分析
- AI可观测
- 组件管理
- 获取集群/节点资源实时使用情况GetResources
- 获取集群节点数量或节点Pod数量GetHostCount
- 开通Alinux控制台InitialSysom
- 获取当前用户纳管集群列表ListClusters
- 获取纳管实例列表ListInstances
- 获取组件的实例列表ListPluginsInstances
- 获取集群/实例中的Pod列表ListPodsOfInstance
- 为 ACK 集群更新组件UpgradeAgentForCluster
- 更新组件UpgradeAgent
- 为ACK集群卸载组件UninstallAgentForCluster
- 卸载组件UninstallAgent
- 获取纳管实例分布的区域列表ListRegions
- 获取包含ECS信息的实例列表ListInstancesWithEcsInfo
- 获取纳管实例状态ListInstanceStatus
- 获取实例的ecs信息的列表ListInstancesEcsInfoList
- 获取 ACK 集群组件安装记录ListClusterAgentInstallRecords
- 获取组件安装记录列表ListAgentInstallRecords
- 为ACK集群安装组件InstallAgentForCluster
- 安装组件InstallAgent
- 获取组件列表ListAgents
- 获取组件任务的执行状态GetAgentTask
- 获取组件详情GetAgent
- 健康度
- 诊断
- OS copilot
InvokeDiagnosis
发起诊断
服务地址:
华东1(杭州)
参数配置
高级配置
输入参数
只看必填
注意事项
body请求体参数
service_name诊断类型
channel诊断通道(目前固定为ecs通道)
params诊断参数
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
对目标 ECS 实例进行诊断有如下要求:
- 目标 ECS 实例状态必须为运行中(Running);
- 目标 ECS 实例必须已经安装云助手,如果未安装,请参考 安装云助手 Agent 进行安装;
- 必须调用 AuthDiagnosis 接口授权 SysOM 对目标 ECS 进行诊断,如果没有授权本接口会直接失败;
- 本接口依赖于 SysOM 服务关联角色(AliyunServiceRoleForSysom)已经创建,本接口不会主动创建服务角色,如果服务角色不存在需要首先调用 AuthDiagnosis 进行授权,该接口会创建前述服务角色。
请求语法
POST /api/v1/openapi/diagnosis/invoke_diagnosis HTTP/1.1
请求参数
字段名称 | 字段详情 |
---|---|
bodyobject | 请求体参数 |
请求说明
诊断参数说明
内存大盘诊断(memgraph)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID, 我们将在会这台机器内部发起诊断 |
内存 Cache 分析诊断(filecache)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID, 我们将在会这台机器内部发起诊断 | |
value | string | 容器 | 否 | 请输入你要诊断的容器 ID,Pod 名,cgroup | |
type | string | 诊断类型 | 否 | all | 请输入需要诊断的类型(容器,POD,cgroup, host, all(所有容器)) |
内存 OOM 诊断(oomcheck)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID, 我们将在会这台机器内部发起诊断 | |
time | string | 诊断时间 | 否 | 请输入需要诊断 OOM 的时间点,默认为最近一次 |
系统负载诊断(loadtask)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID, 我们将在会这台机器内部发起诊断 |
调度抖动诊断(schedmoni)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID, 我们将在会这台机器内部发起诊断 | |
timeout | string | 诊断时间 | 否 | 20 | 本次的期望的诊断时间,默认 20 秒 |
threshold | string | 诊断阈值 | 否 | 20 | 延迟的阈值,超过这个阈值就记录,默认 20ms |
IO 延迟诊断(iolatency)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID,我们将在会这台机器内部发起 IO 时延诊断 | |
timeout | string | 诊断时长 | 否 | 10 | 请输入你要诊断的时长,单位秒 |
threshold | string | 时间阈值 | 否 | 1000 | 保留 IO 延迟大于设定时间阈值的 IO(时间单位:ms) |
disk | string | 目标磁盘 | 否 | "" | 请输入你要诊断的磁盘,如 vda,sdb,缺省为所有磁盘 |
IO 流量分析诊断(iofsstat)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID,我们将在会这台机器内部发起 IO 流量统计 | |
timeout | string | 诊断时长 | 否 | 15 | 诊断时长,也是 IO 流量统计周期,单位秒,建议不超过 60 秒 |
disk | string | 目标磁盘 | 否 | "" | 请输入你要诊断的磁盘,如 vda,sda,缺省为所有磁盘 |
IO Hang 诊断(iohang)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID,我们将在会这台机器内部发起 IO HANG 诊断 | |
timeout | string | 诊断时长 | 否 | 10 | 请输入你要诊断的时长,单位秒 |
threshold | string | 时间阈值 | 否 | 5000 | 保留 IO HANG 住时间超过阈值的 IO,单位毫秒 |
disk | string | 目标磁盘 | 否 | "" | 请输入你要诊断的磁盘,如 vda,sda,缺省为所有磁盘 |
网络丢包诊断(packetdrop)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID, 我们将在会这台机器内部发起诊断 | |
time | string | 运行时间 | 否 | 10 | 请输入你要诊断的时间,单位秒 |
网络重传诊断(retran)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID, 我们将在会这台机器内部发起诊断 | |
time | string | 运行时间 | 否 | 10 | 请输入你要诊断的时间,单位秒 |
网络抖动诊断(jitter)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
instance | string | 实例 ID | 是 | 请输入你要诊断的实例 ID, 我们将在会这台机器内部发起诊断 | |
time | string | 运行时间 | 否 | 10 | 请输入你要诊断的时间,单位秒 |
网络时延诊断(pingtrace)参数
参数名称 | 参数类型 | 参数说明 | 是否必填 | 默认值 | 备注 |
---|---|---|---|---|---|
origin_instance | string | 源实例 ID | 是 | 请输入你要诊断的源实例 ID, 我们将在会这台机器内部发起 SysAK 诊断 | |
target_instance | string | 目标实例 ID | 是 | 请输入你要诊断的目标实例 ID, 我们将在会这台机器内部发起 SysAK 诊断 | |
pkg_num | string | 追踪包数 | 否 | 100 | 请输入你要追踪的包数 |
time_gap | string | 间隔毫秒数 | 否 | 1000 | 请输入发包间隔 |
type | string | 报文协议 | 否 | icmp | 请输入报文协议(icmp,tcp,udp) |
返回参数
变更历史
暂无变更历史