云服务器内容精选

  • 请求示例 https://coc.myhuaweicloud.com/v1/event/huawei/custom/{integration_key} { "alarmId" : "18cfxxxxxxxxxx0f8", "alarmName" : "Cpu 使用超额预警", "alarmLevel" : "Critical", "time" : 1709118444540, "nameSpace" : "shanghai", "regionId" : "cn-north-4", "applicationId" : "18cfa0a5ef8d", "resourceName" : "machine-1", "resourceId" : "18cxxxxxxxxxxxxff68625", "alarmDesc" : "string", "URL" : "https://xxx.com", "alarmStatus" : "alarm", "alarmSource" : "coc", "additional" : { } }
  • 响应示例 状态码: 200 请求成功 { "error_code" : "COC.00000000", "error_msg" : "success", "data" : null, "provider_code" : "049" } 状态码: 400 请求体有误 { "error_code" : "COC.00000001", "error_msg" : "alarmName must not be null | alarmId must not be null", "data" : null, "provider_code" : "049" } 状态码: 401 鉴权有误 { "error_code" : "common.01010001", "error_msg" : "Token missing or invalid.", "data" : null, "provider_code" : "049" }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 alarmId 是 String 告警id 最小长度:1 最大长度:255 alarmName 是 String 告警名称 最小长度:1 最大长度:255 alarmLevel 是 String 告警级别。取值为Critical(紧急), Major(重要), Minor(次要), Info(提示) 最小长度:1 最大长度:255 枚举值: Critical Major Minor Info time 是 Long 告警发生时间 nameSpace 是 String 服务的命名空间 最小长度:1 最大长度:255 regionId 否 String 告警发生区域 最小长度:0 最大长度:255 applicationId 是 String 应用id 最小长度:1 最大长度:255 resourceName 否 String 资源名称 最小长度:0 最大长度:255 resourceId 否 String 资源ID 最小长度:0 最大长度:255 alarmDesc 是 String 告警描述 最小长度:1 最大长度:255 URL 否 String 原始告警URL 最小长度:0 最大长度:255 alarmStatus 否 String 告警状态。一般取值为alarm(告警中)和ok(已恢复) 最小长度:0 最大长度:255 枚举值: alarm ok alarmSource 是 String 告警源 最小长度:1 最大长度:255 additional 否 Object 告警附加信息
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000,请求成功 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000 状态码: 400 表3 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000
  • 请求示例 GET https://IP:PORT/v1/external/incident/handle Request Headers: Content-Type: application/json X-Auth-Token: MI*******ghkgB { "incident_num":"IM202403221515060171753781", "operator":"7da46971b7e24eed90cf777cc2ff8b91", "operate_key":"confirm", "parameter":{ "virtual_confirm_result": false, "virtual_confirm_comment": "13" } }
  • 请求示例 GET https://IP:PORT/v1/external/incident/create Request Headers: Content-Type: application/json X-Auth-Token: MI*******ghkgB Request Body: { "region": [ "cn-southwest-252" ], "enterprise_project": [ "ab080d9f-6b97-4e73-8679-b6d76057f274" ], "current_cloud_service": [ "65659ae2f42bf80e5f3f0635" ], "incident_level": "level_50", "is_service_interrupt": "true", "incident_type": "inc_type_p_security_issues", "incident_title": "测试时间单号10001", "incident_description": "测试时间单号10001", "incident_source": "incident_source_manual", "incident_assignee": ["7da46971b7e24eed90cf777cc2ff8b91"], "creator": "7da46971b7e24eed90cf777cc2ff8b91", "assignee_scene": "", "assignee_role": "" }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000 data CreateExternalIncidentResponseData object data 表3 CreateExternalIncidentResponseData 参数 参数类型 描述 incident_num String 事件单号 最小长度:0 最大长度:255 状态码: 400 表4 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 region 否 Array of strings 区域Code,如果自动拉起WarRoom则为必填,现在只支持1个 最小长度:0 最大长度:255 数组长度:0 - 1 enterprise_project 否 Array of strings 企业项目ID,当前只支持1个 最小长度:0 最大长度:255 数组长度:0 - 1 current_cloud_service 是 Array of strings 归属应用ID,当前只支持1个 最小长度:0 最大长度:255 数组长度:0 - 1 incident_level 是 String 事件级别 参考:枚举 事件级别incident_level 最小长度:0 最大长度:255 is_service_interrupt 是 Boolean 业务是否中断,取值:true/false 枚举值: true false incident_type 是 String 事件类别 参考:枚举 事件类别incident_type 最小长度:0 最大长度:255 incident_title 是 String 事件标题,最大长度:200 最小长度:0 最大长度:200 incident_description 是 String 事件描述,最大长度:600 最小长度:0 最大长度:600 incident_source 是 String 单据来源 参考:枚举 事件来源incident_source 最小长度:0 最大长度:255 incident_assignee 否 Array of strings 责任人,排班场景和排班角色(排班场景和排班角色是作为组合项)不能同时为空,必须选择一个 最小长度:0 最大长度:255 数组长度:0 - 1 assignee_scene 否 String 排班场景,排班场景和排班角色(排班场景和排班角色是作为组合项)不能同时为空,必须选择一个最小长度:0 最大长度:255 assignee_role 否 String 排班角色,依赖排班场景 最小长度:0 最大长度:255 creator 是 String 创单人 最小长度:0 最大长度:255 incident_assignee(责任人)和assignee_scene(排班场景)、assignee_role(排班角色)必须填写其中一个。如果填写了incident_assignee,可不用填写assignee_scene和assignee_role,assignee_scene和assignee_role是捆绑在一起的。
  • 响应示例 { "provider_code": "049", "error_code": "GOM.00000000", "error_msg": null, "data": { "incident_num": "IM202403181322030178042608", "region": [ "" ], "enterprise_project": [ "0" ], "current_cloud_service": [ "6470681a31da2a47ed50a919" ], "incident_level": "level_50", "is_service_interrupt": true, "incident_type": "inc_type_p_function_issues", "incident_title": "tet", "incident_description": "25819b46251b46218bf6ad238ddd860c", "incident_source": "incident_source_manual", "incident_assignee": [ "25819b46251b46218bf6ad238ddd860c" ], "assignee_scene": "", "assignee_role": "", "warroom_id": "WR202403181334366050100030", "handle_time": null, "status": "INCIDENT_STATUS_ACKNOWLEDGED", "create_time": 1710739323172, "creator": "1", "enum_data_list": [ { "filed_key": "current_cloud_service_id", "enum_key": "6470681a31da2a47ed50a919", "name_zh": "COC", "name_en": "COC" }, { "filed_key": "creator", "enum_key": "25819b46251b46218bf6ad238ddd860c", "name_zh": "coc-cim-user", "name_en": "coc-cim-user" }, { "filed_key": "level_id", "enum_key": "level_50", "name_zh": "P5", "name_en": "P5" }, { "filed_key": "work_flow_status", "enum_key": "INCIDENT_STATUS_ACKNOWLEDGED", "name_zh": "已受理", "name_en": "ACKNOWLEDGED" }, { "filed_key": "mtm_type", "enum_key": "inc_type_p_function_issues", "name_zh": "功能问题", "name_en": "function issues" }, { "filed_key": "source_id", "enum_key": "incident_source_manual", "name_zh": "人工创建", "name_en": "Manual Creation" }, { "filed_key": "assignee", "enum_key": "25819b46251b46218bf6ad238ddd860c", "name_zh": "coc-cim-user", "name_en": "coc-cim-user" } ] } }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000 data IncidentTicketInfoResponseData object data 表3 IncidentTicketInfoResponseData 参数 参数类型 描述 incident_num String 事件单号 最小长度:0 最大长度:255 region Array of strings 区域Code,如果自动拉起WarRoom则为必填,当前只支持1个 最小长度:0 最大长度:255 数组长度:0 - 1 enterprise_project Array of strings 企业项目ID,当前只支持1个 最小长度:0 最大长度:255 数组长度:0 - 1 current_cloud_service Array of strings 归属应用ID,当前只支持1个 最小长度:0 最大长度:255 数组长度:0 - 1 incident_level String 事件级别 参考:枚举 事件级别incident_level 最小长度:0 最大长度:255 is_service_interrupt Boolean 业务是否中断,取值:true/false 枚举值: true false incident_type String 事件类别 参考:枚举 事件类别incident_type 最小长度:0 最大长度:255 incident_title String 事件标题,最大长度:200 最小长度:0 最大长度:200 incident_description String 事件描述,最大长度:600 最小长度:0 最大长度:600 incident_source String 单据来源 参考:枚举 事件来源incident_source 最小长度:0 最大长度:255 incident_assignee Array of strings 责任人 最小长度:0 最大长度:255 数组长度:0 - 1 assignee_scene String 排班场景 最小长度:0 最大长度:255 assignee_role String 排班角色 最小长度:0 最大长度:255 warroom_id String warroom_id 最小长度:0 最大长度:255 handle_time Long 最后一次提交解决方案时间戳 最小值:1 最大值:9999999999 status String 状态KEY,参考:枚举 事件状态 最小长度:0 最大长度:255 create_time Long 创单时间戳 最小值:0 最大值:999999999 creator String 创单人 最小长度:0 最大长度:255 enum_data_list Array of TicketInfoEnumData objects 枚举列表 数组长度:0 - 100000000 表4 TicketInfoEnumData 参数 参数类型 描述 filed_key String 字段KEY 标识哪个字段 最小长度:0 最大长度:255 enum_key String 枚举KEY 最小长度:0 最大长度:255 name_zh String 中文名称 最小长度:0 最大长度:255 name_en String 英文名称 最小长度:0 最大长度:255 状态码: 400 表5 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000
  • 请求示例 POST https://IP:PORT/v1/external/incident/handle Request Headers: Content-Type: application/json X-Auth-Token: MI*******ghkgB Request Body: { "incident_num":"IM202403221515060171753781", "operator":"7da46971b7e24eed90cf777cc2ff8b91", "operate_key":"acceptedIncident1", "parameter":{} }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000 状态码: 400 表3 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000 请求成功 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000 状态码: 400 表3 响应Body参数 参数 参数类型 描述 provider_code String 服务标识 缺省值:049 最小长度:3 最大长度:100000000 error_code String 请求响应代码,范围:0000~9999,正常时取值:0 缺省值:GOM.00000000,错误编码 最小长度:1 最大长度:100000000 error_msg String 请求响应描述 最小长度:0 最大长度:100000000
  • 请求示例 GET https://IP:PORT/v1/external/incident/handle Request Headers: Content-Type: application/json X-Auth-Token: MI*******ghkgB Request Body: { "incident_num":"IM202403221515060171753781", "operator":"7da46971b7e24eed90cf777cc2ff8b91", "operate_key":"commitSolution1", "parameter":{ "mtm_type": "inc_type_p_config_issues", "is_service_interrupt": true, "cause": "100001", "solution": "20001" } }
  • URI GET /v1/resources 表1 Query参数 参数 是否必选 参数类型 描述 resource_id_list 否 Array 资源id列表 provider 是 String 云服务名称 type 是 String 资源类型名称 limit 是 Integer 最大的返回数量 marker 否 String 分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页