云运维中心 COC
云运维中心 COC
链接复制成功!
提交诊断任务
功能介绍
提交实例诊断任务,任务提交后后台异步执行。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/diagnosis/tasks
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
resource_ids |
否 |
Array of strings |
参数解释: 待诊断的实例ID。 约束限制: 请选择应用资源管理页面中存在的资源ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
type |
否 |
String |
参数解释: 被诊断实例的类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
extra_properties |
否 |
Array of strings |
参数解释: 适用于RDS、DMS、DCS、ELB等的额外参数。 约束限制: 应按照JSON字符串格式组织,数组长度应与提交实例数组长度一致。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 请参考错误码章节。 |
error_msg |
String |
参数解释: 错误信息。 取值范围: 请参考错误码章节。 |
id |
String |
参数解释: 诊断工单ID。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 请参考错误码章节。 |
error_msg |
String |
参数解释: 错误信息。 取值范围: 请参考错误码章节。 |
状态码:500
请求示例
-
提交RDS诊断任务
POST https://{Endpoint}/v1/diagnosis/tasks { "description" : "RDS诊断任务提交请求的结构体", "value" : { "resource_ids" : [ "rds_resource_id1", "rds_resource_id2" ], "type" : "RDS", "extra_properties" : [ "{\"engine_name\": \"mysql\"}", "{\"engine_name\": \"gaussdb\"}" ] } }
-
提交DCS诊断任务
POST https://{Endpoint}/v1/diagnosis/tasks { "description" : "DCS诊断任务提交请求的结构体", "value" : { "resource_ids" : [ "dcs_resource_id1", "dcs_resource_id2" ], "type" : "DCS", "extra_properties" : [ "{\"begin_time\":1751012899168,\"end_time\":1751013499168,\"node_ip_list\":[\"xx.xx.xx.xx\"]}", "{\"begin_time\":1751012299000,\"end_time\":1751012899000,\"node_ip_list\":[\"xx.xx.xx.xx\"]}" ] } }
-
提交DMS诊断任务
POST https://{Endpoint}/v1/diagnosis/tasks { "description" : "DMS诊断任务提交请求的结构体", "value" : { "resource_ids" : [ "dms_resource_id1", "dms_resource_id2" ], "type" : "DMS", "extra_properties" : [ "{\"group_name\":\"dms_resource_group_1\",\"topic_name\":\"dms_resource_group_1_topic_1\"}", "{\"group_name\":\"dms_resource_group_2\",\"topic_name\":\"dms_resource_group_2_topic_2\"}" ] } }
-
提交ELB诊断任务
POST https://{Endpoint}/v1/diagnosis/tasks { "description" : "ELB诊断任务提交请求的结构体", "value" : { "resource_ids" : [ "elb_resource_id1", "elb_resource_id2" ], "type" : "ELB", "extra_properties" : [ "{\"member_id\":\"elb_member_1_id\",\"label\":\"elb_member_1_label\"}", "{\"member_id\":\"elb_member_2_id\",\"label\":\"elb_member_2_label\"}" ] } }
响应示例
状态码:200
请求成功。
{
"id" : "DIAyyyyMMddHHmmss123456789"
}
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
客户端请求错误。 |
500 |
服务端请求错误。 |
错误码
请参见错误码。
父主题: 故障诊断