创建一次集群诊断任务
功能介绍
该接口用于创建一个集群诊断任务。
适用于Elasticsearch和OpenSearch引擎。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/ai-ops
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| check_type | 否 | String | 参数解释: 诊断类型 约束限制: 不涉及 取值范围: 默认取值: full_detection |
| check_items | 否 | Array of strings | 参数解释: 全量检测项中选取其中部分检测项进行检测,输入检测项列表。 约束限制: 当check_type为partial_detection时有效 取值范围: 通过智能运维ShowAiOpsDetector获取最新支持的检测项,输入检测项id字符串列表 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 检测报告名称,支持自定义检测名。 约束限制: 不涉及 取值范围: 4~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
| description | 否 | String | 参数解释: 检测报告描述,支持自定义检测描述 约束限制: 不涉及 取值范围: 0~255个字符 默认取值: 不涉及 |
| alarm | 否 | alarm object | 参数解释: 检测报告发送,当前功能已废弃。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
请求成功。
无
请求示例
-
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops { "check_type" : "partial_detection", "check_items" : [ "nodeDiskCheck" ] } -
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops { "check_type" : "full_detection", "check_items" : [ ] }
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 非法请求。 建议直接修改该请求,不要重试该请求。 |
| 409 | 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 |
| 412 | 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。