华为云用户手册

请求示例 https://{endpoint}/v1/external/warrooms/list { "offset" : 0, "limit" : 10, "incident_num" : "IM202504101040150000000000", "title" : "warroom名称", "region_code_list" : [ "region_code1", "region_code2" ], "incident_levels" : [ "level_40", "level_50" ], "impacted_application_ids" : [ "service_id1", "service_id2" ], "admin" : [ "user_id1", "user_id2" ], "status" : [ 0 ], "triggered_start_time" : 1743350400000, "triggered_end_time" : 1745942400000, "occur_start_time" : 1743350400000, "occur_end_time" : 1745942400000, "recover_start_time" : 1743350400000, "recover_end_time" : 1745942400000, "notification_level" : [ "level_40", "level_50" ], "enterprise_project_ids" : [ "project_id1", "project_id2" ], "war_room_num" : "war_room_num", "statistic_flag" : false, "current_users" : [ "user_id1", "user_id2" ], "war_room_nums" : [ "war_room_num1", "war_room_num2" ] }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 provider_code String 服务标识。 缺省值：4 最小长度：3 最大长度：3 error_code String 请求响应代码，为8位数字组成，前四位标记当前服务为warroom服务，后四位标记错误类型。 最小长度：8 最大长度：8 error_msg String 请求响应描述。 最小长度：0 最大长度：10240 data data object 响应数据 表3 data 参数 参数类型 描述 list Array of WarRoomTenantInfo objects warroom信息。 数组长度：0 - 1000 total Long 当前查询条件下查到的warroom总数。 最小值：0 最大值：9223372036854775807 running_num Long 进行中warroom总数。 最小值：0 最大值：9223372036854775807 closed_num Long 已关闭warroom总数。 最小值：0 最大值：9223372036854775807 total_num Long warroom总数。 最小值：0 最大值：9223372036854775807 表4 WarRoomTenantInfo 参数 参数类型 描述 id String warroom存在后台数据库的主键ID。 最小长度：0 最大长度：100 title String warroom名称 最小长度：0 最大长度：255 admin String warroom管理员。 最小长度：0 最大长度：255 recover_member Array of strings 恢复成员。 最小长度：0 最大长度：255 数组长度：0 - 1000 recover_leader Array of strings 主恢复责任人。 最小长度：0 最大长度：255 数组长度：0 - 1000 incident WarRoomIncident object 事件单信息。 source String 事件来源。 最小长度：0 最大长度：255 regions Array of regions objects 影响的Region。 数组长度：0 - 1000 change_num String 变更单号。 最小长度：0 最大长度：255 occur_time Long 开始时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 recover_time Long 故障恢复时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 fault_cause String 故障原因。 最小长度：0 最大长度：255 create_time Long 添加时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 first_report_time Long 首次通报时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 recovery_notification_time Long 恢复通报时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 fault_impact String 故障影响。 最小长度：0 最大长度：255 description String warRoom描述。 最小长度：0 最大长度：255 circular_level String 通报级别，同事件级别。 最小长度：0 最大长度：32 war_room_status WarRoomEnumeration object warroom状态信息。 impacted_application Array of impacted_application objects 影响应用信息。 数组长度：0 - 1000 processing_duration Long 处理时长（分钟）。 最小值：0 最大值：9223372036854775807 restoration_duration Long 恢复时长（分钟）。 最小值：0 最大值：9223372036854775807 war_room_num String warroom单号。 最小长度：0 最大长度：255 enterprise_project_id String 企业项目id。 最小长度：0 最大长度：64 表5 WarRoomIncident 参数 参数类型 描述 id String 后台数据库存储的主键ID。 最小长度：0 最大长度：100 incident_id String 事件单单号ID。 最小长度：0 最大长度：32 is_change_event Boolean 是否变更事件。 failure_level String 事件级别。 最小长度：0 最大长度：32 incident_url String 事件单号链接。 最小长度：0 最大长度：20000 表6 regions 参数 参数类型 描述 code String 主键ID。 最小长度：0 最大长度：100 name String region名称。 最小长度：0 最大长度：255 表7 WarRoomEnumeration 参数 参数类型 描述 id String 枚举值ID。 最小长度：0 最大长度：255 name_zh String 枚举值中文名。 最小长度：0 最大长度：255 name_en String 枚举值英文名。 最小长度：0 最大长度：255 type String 枚举类型。 最小长度：0 最大长度：255 表8 impacted_application 参数 参数类型 描述 id String 受影响服务对应的唯一ID。 最小长度：0 最大长度：100 name String 受影响服务的名字，比如CloudMonitorAlarm。 最小长度：0 最大长度：255 状态码：400 表9 响应Body参数 参数 参数类型 描述 provider_code String 服务标识。 缺省值：049 最小长度：3 最大长度：3 error_code String 请求响应代码，为8位数字组成，前四位标记当前服务为warroom服务，后四位标记错误类型。 最小长度：8 最大长度：8 error_msg String 请求响应异常时报错信息。 最小长度：0 最大长度：10240 data Object 响应数据。

功能介绍 该接口可分页查询到warroom信息，分页参数为limit与offset。同时可对warroom关联的事件单单号incident_num、标题title、状态status等进行过滤，更多过滤参数详见请求参数说明。查询结果包含warroom名称、warroom状态、关联事件单信息等。同时该接口也可以只返回当前warroom的统计结果，当statistic_flag参数为true时，返回当前租户下共多少warroom（total_num），已关闭（closed_num）和未关闭（running_num）的数量。

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 limit 否 Integer 列表查询接口分页参数，表示一页查询多少条数据，该值需大于等于1且为整数，表示分页查询时每一页最多查到的数量。 最小值：0 最大值：1000 缺省值：0 offset 否 Integer 列表查询接口分页参数，表示当前查询第几页，0表示查询第一页。 最小值：0 最大值：2147483647 缺省值：0 incident_num 否 String 事件单号，对单号进行搜索时为精确查询，需要填写准确的事件单号。 最小长度：0 最大长度：64 title 否 String warroom名称，对warroom名称进行搜索时为模糊查询。 最小长度：0 最大长度：1000 region_code_list 否 Array of strings 对区域进行过滤，传值为region_id，可同时传递多个region_id，例如：["cn-north-4"]表示过滤北京四下的warroom。 最小长度：0 最大长度：200 数组长度：0 - 1000 incident_levels 否 Array of strings 对事件级别进行过滤，可同时传递多个值，可传递的值范围为：level_10、level_20、level_30、level_40和level_50，分别对应P1、P2、P3、P4和P5。 最小长度：0 最大长度：32 数组长度：0 - 1000 impacted_application_ids 否 Array of strings 对影响应用进行过滤，传值为应用ID。 最小长度：0 最大长度：200 数组长度：0 - 1000 admin 否 Array of strings warroom管理员，传值为用户ID。 最小长度：0 最大长度：200 数组长度：0 - 1000 status 否 Array of strings warroom状态，过滤场景下需要传递状态ID。当前warroom状态分别为启动 warroom（状态ID：1）、故障界定（状态ID：3）、故障已恢复（状态ID：7）、warroom关闭（状态ID：20）。 最小长度：0 最大长度：10 数组长度：0 - 100 triggered_start_time 否 Long warroom拉起时间，值为13位时间戳，默认前30天。 最小值：0 最大值：9223372036854775807 triggered_end_time 否 Long warroom结束时间，默认为当前时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 occur_start_time 否 Long 故障发生时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 occur_end_time 否 Long 故障结束时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 recover_start_time 否 Long 故障恢复开始时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 recover_end_time 否 Long 故障恢复结束时间，值为13位时间戳。 最小值：0 最大值：9223372036854775807 notification_level 否 Array of strings 通报级别，可同时传递多个值，可传递的值范围为：level_10、level_20、level_30、level_40和level_50，分别对应P1、P2、P3、P4和P5。 最小长度：0 最大长度：32 数组长度：0 - 1000 enterprise_project_ids 否 Array of strings 企业项目id，可多选。 最小长度：0 最大长度：64 数组长度：0 - 500 war_room_num 否 String warroom单号。 最小长度：0 最大长度：255 statistic_flag 否 Boolean 是否只返回统计数据，当值为false返回基本信息，值为true接口只返回统计结果：total_num,running_num,closed_num。 缺省值：false current_users 否 Array of strings 当前用户ID。 最小长度：0 最大长度：200 数组长度：0 - 1000 war_room_nums 否 Array of strings warroom单号，当有这个筛选条件时，其他筛选条件忽略。 最小长度：0 最大长度：255 数组长度：0 - 1000

响应示例 状态码：200 脚本分页数据。 更多状态码请参考状态码。 { "data" : { "total" : 70, "data" : [ { "id" : 6229, "name" : "测试111", "type" : "SHELL", "creator" : "runbook_notif", "creator_id" : "e56462d17f334b8789ff0b5b9cca3bb9", "operator" : null, "gmt_created" : 1701314214271, "gmt_modified" : null, "status" : "APPROVED", "script_uuid" : "SC20231130111654023511657", "usage_count" : 0, "properties" : { "risk_level" : "HIGH", "reviewers" : [ ], "version" : "1.0.0", "protocol" : null }, "enterprise_project_id" : 0 }, { "id" : 6228, "name" : "测试11", "type" : "SHELL", "creator" : "runbook_notif", "creator_id" : "e56462d17f334b8789ff0b5b9cca3bb9", "operator" : null, "gmt_created" : 1701314090063, "gmt_modified" : null, "status" : "APPROVED", "script_uuid" : "SC20231130111450026f7f8b2", "usage_count" : 0, "properties" : { "risk_level" : "LOW", "reviewers" : [ ], "version" : "1.0.0", "protocol" : null }, "enterprise_project_id" : 0 } ] } } 状态码：400 包含错误信息。 更多状态码请参考状态码。 { "error_code" : "COC.00040701", "error_msg" : "error_msg" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data ScriptListPage object 脚本列表返回体。 表4 ScriptListPage 参数 参数类型 描述 total Long 总条数。 data Array of ScriptListModel objects 单页数据列表。 表5 ScriptListModel 参数 参数类型 描述 id Long 脚本自增id。 script_uuid String 脚本uuid。 enterprise_project_id String 企业项目ID，默认为：0。 name String 脚本名称。 type String 脚本类型 SHELL：shell脚本。 PYTHON：python脚本。 BAT：bat脚本。 status String 脚本状态。 PENDING_APPROVE：待审批。 APPROVED：正常（审批通过）。 REJECTED：驳回（审批人，驳回该脚本）。 gmt_created Long 创建时间。 gmt_modified Long 修改时间。 creator String 创建人。 creator_id String 创建人Id。 operator String 修改人。 properties ScriptPropertiesModel object 脚本标签：风险等级risk_level(取值范围：LOW/MEDIUM/HIGH)、审批人reviewer。 表6 ScriptPropertiesModel 参数 参数类型 描述 risk_level String 风险等级。 LOW：低风险。 MEDIUM：中风险。 HIGH：高风险。 version String 脚本版本号。 reviewers Array of ReviewerInfo objects 审批人，不填写不需要审批。 protocol String 审批 消息通知 协议，用于通知审批人。 DEFAULT：默认。 SMS ：短信。 EMAIL：邮件。 DING_TALK：钉钉。 WE_LINK：welink。 WECHAT：微信。 CALLNOTIFY：语言。 NOT_TO_NOTIFY：不通知。 表7 ReviewerInfo 参数 参数类型 描述 reviewer_name String 审批人名称（ IAM 用户名）。 reviewer_id String 审批人ID（IAM用户Id）。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/job/scripts 表1 Query参数 参数 是否必选 参数类型 描述 limit 是 Integer 分页参数：每页返回记录个数限制。 marker 否 Long 分页参数：上一页最后一个记录id。 name_like 否 String 脚本名（模糊）。 creator 否 String 创建人。 risk_level 否 String 风险等级 LOW：低风险。 MEDIUM：中风险。 HIGH：高风险。 type 否 String 脚本类型 SHELL：shell脚本。 PYTHON：python脚本。 BAT：Bat脚本。 enterprise_project_id 否 String 企业项目id。

响应示例 状态码：200 E CS 资源信息。 { "data" : [ { "id" : "67dbfc5b38f2266b00bfbcce", "resource_id" : "dc3334d0-12a7-4149-9445-4d9f50631b6d", "name" : "COC-jumper项目使用误删", "description" : "null", "ep_id" : "0", "project_id" : "6bd69b78b15b46c79814ba748415e643", "domain_id" : "87ee79a270314bdb8b4749f3004e3685", "provider" : "ecs", "type" : "cloudservers", "region_id" : "ap-southeast-1", "tags" : [ { "key" : "t1", "value" : "t2" } ], "properties" : [ { "accessIpv4" : "", "hostName" : "coc-jumper", "addresses" : [ { "OsExtIpsType" : "fixed", "OsExtIpsPortId" : "9f43a922-c983-4133-a491-54ba825cb724", "addr" : "192.168.0.222", "version" : 4, "OsExtIpsMacAddr" : "fa:16:3e:9a:f2:d0", "primary" : true }, { "OsExtIpsType" : "floating", "OsExtIpsPortId" : "9f43a922-c983-4133-a491-54ba825cb724", "addr" : "150.40.253.144", "version" : 4, "OsExtIpsMacAddr" : "fa:16:3e:9a:f2:d0", "primary" : true } ], "accessIpv6" : "", "metadata" : [ { "chargingMode" : "0", "meteringImageType" : "market", "imageName" : "Windows Server 2022 数据中心版 64位 中文_40GB", "meteringImageId" : "b51669dc-6277-4598-b892-aec7050e11d1", "meteringResourcesPerCode" : "c6.xlarge.2.win", "vpcId" : "dd9d50ce-a1d0-4b1e-acfa-10038ea8b0f2", "osBit" : "64", "osType" : "Windows" } ], "OsExtStsVmState" : "active", "configDrive" : "", "OsExtStsPowerState" : 1, "hostId" : "e7d72632bbf648fe80ef364661f263c2599b9449c12cd077b02dd547" } ], "ingest_properties" : null, "agent_id" : null, "agent_state" : null, "is_delegated" : null, "operable" : null, "create_time" : "2025-03-20T11:30:33.000+00:00", "update_time" : "2025-03-31T16:51:33.000+00:00" } ] } 状态码：400 包含错误信息 { "error_code" : "COC.00101004", "error_msg" : "limit exceeds the maximum." }

功能介绍 查询租户所有资源： 查询租户所有资源等相关信息，便于租户详细了解资源总体情况。 请求参数provider（云服务名称），type（云资源类型），limit（查询条数）必填，单次最大查询条数：500。 返回信息包括：资源ID，资源名称，云服务名称，资源类型，项目ID，租户ID，区域ID，企业项目ID，资源标签，资源详细属性，资源ingest属性，uniagentID，uniagent状态，是否托管，是否可运维。

URI GET /v1/resources 表1 Query参数 参数 是否必选 参数类型 描述 name 否 String 云资源名称。 ep_id 否 String 企业项目ID，租户设置。 project_id 否 String 项目ID。 获取方式请参考获取项目ID。 region_id 否 String 区域ID。 az_id 否 String 可用区ID。 ip_type 否 String IP类型 fixed：内网IP floating：弹性公网IP ip 否 String IPv4地址过滤结果，匹配规则为模糊匹配。此处IP为云资源IP。 ip_list 否 Array of strings 云资源IP列表，最大长度:100。 resource_id_list 否 Array of strings 云资源ID列表，最大长度:100。 provider 是 String 云服务名称。 status 否 String 云资源状态，枚举值见云资源状态。 agent_state 否 String uniagent状态。 运行中。 异常。 安装中。 安装失败。 已卸载。 未安装。 image_name 否 String 镜像名称，模糊匹配。 os_type 否 String 云资源操作系统类型。 tag 否 String 云资源的标签。 标签的格式为“key.value”。其中，key的长度不超过36个字符，value的长度不超过43个字符。 标签命名时，需满足如下要求： 标签的key值只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（）、中划线（-）以及中文字符。 标签的value值只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（）、中划线（-）、小数点（.）以及中文字符。 tag_key 否 String 云资源的标签key。 group_id 否 String 云资源下的分组ID。 component_id 否 String 云资源下组件ID。 application_id 否 String 云资源下应用ID。 cce_cluster_id 否 String cce集群ID，资源属于的cce的ID。 vpc_id 否 String 待创建云资源所属虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。 is_delegated 否 Boolean 是否已托管。 operable 否 String 用户定义资源是否可运维实例。 enable：启用； 不存在当前字段：不启用。 is_collected 否 Boolean 是否已收藏。 flavor_name 否 String 云资源规格名称。 charging_mode 否 String 云服务器的计费类型： 0：按需计费 1：包年包月 2：竞价计费 type 是 String 资源类型名称，非空。 limit 是 Integer 最小返回数量:1，最大返回数量:500，非空。 marker 否 String 分页参数，通过上一个请求中返回的marker信息（云资源ID）作为输入，获取当前页。

响应示例 状态码：200 节点合规性报告信息 { "count" : 1, "instance_compliant" : [ { "baseline_id" : "JX-f2d85e2554f7385cbbf2c23a01f41", "baseline_name" : "COC-EulerOSDefaultPatchBaseline", "cce_info_id" : null, "compliant_summary" : { "compliant_count" : 264, "severity_summary" : { "critical_count" : 0, "high_count" : 0, "informational_count" : 0, "low_count" : 0, "medium_count" : 0, "unspecified_count" : 264 } }, "eip" : null, "enterprise_project_id" : "string", "execution_summary" : { "job_id" : "string", "order_id" : "string", "report_time" : 1715308575000 }, "group" : null, "id" : "string", "instance_id" : "string", "ip" : "string", "name" : "string", "node_id" : "", "non_compliant_summary" : { "non_compliant_count" : 204, "severity_summary" : { "critical_count" : 0, "high_count" : 0, "informational_count" : 0, "low_count" : 0, "medium_count" : 0, "unspecified_count" : 0 } }, "operating_system" : "EulerOS", "region" : "string", "report_scene" : "ECS", "rule_type" : "standard", "status" : "non_compliant" } ] } 状态码：500 错误信息返回 { "error_code" : "string", "error_msg" : "string" }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 count Long 总条数 instance_compliant Array of InstanceCompliant objects 节点合规报告 表3 InstanceCompliant 参数 参数类型 描述 compliant_summary CompliantSummary object 合规补丁信息 non_compliant_summary NonCompliantSummary object 不合规补丁信息 execution_summary ExecutionSummary object 执行信息 id String id enterprise_project_id String 企业项目id name String 节点名称 instance_id String 节点ID node_id String cce集群节点ID ip String 节点IP eip String 弹性公网ip region String 区域 group String 分组 report_scene String 报告场景(CCE,ECS) cce_info_id String cce 集群信息id status String 合规性状态 baseline_id String 基线id baseline_name String 基线名称 rule_type String 基线规则类型 operating_system String 操作系统 表4 CompliantSummary 参数 参数类型 描述 compliant_count Integer 合规补丁数量 severity_summary SeveritySummary object 合规总结 表5 NonCompliantSummary 参数 参数类型 描述 non_compliant_count Integer 不合规补丁数量 severity_summary SeveritySummary object 合规总结 表6 SeveritySummary 参数 参数类型 描述 critical_count Integer 重大合规性报告数量 high_count Integer 高合规性报告数量 informational_count Integer 信息性合规性报告数量 low_count Integer 低合规性报告数量 medium_count Integer 中级合规性报告数量 unspecified_count Integer 未指定合规性报告数量 表7 ExecutionSummary 参数 参数类型 描述 order_id String 工单Id job_id String 脚本执行Id report_time Long 报告时间 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/patch/instance/compliant 表1 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id name 否 String 名称 instance_id 否 String ECS实例id ip 否 String 内网ip eip 否 String 弹性公网ip operating_system 否 String 操作系统 HuaweiCloudEulerOS CentOS EulerOS region 否 String 区域 group 否 String 分组 compliant_status 否 String 合规性状态 non_compliant：不合规 compliant：合规 order_id 否 String 工单id offset 否 Integer 偏移量 limit 否 Integer 每页数量 sort_dir 否 String 排序 asc：升序 desc：降序 sort_key 否 String 排序字段 report_time：报告时间 report_scene 否 String 报告场景 CCE ECS cce_info_id 否 String cce 集群信息id

请求示例 获取事件操作历史列表。 POST https://{Endpoint}/v2/incidents/{incident_id}/histories { "sort_filter": { "operator": "desc", "field": "start_time", "name": "start_time", "values": [ "start_time" ] } }

响应示例 状态码：200 请求成功。 更多状态码请参考状态码。 { "provider_code": "049", "error_code": "GOM.00000000", "error_msg": null, "data": { "total": 3, "info": [ { "action": "incident_accept", "operator": "653989085ba7487184d7cf219b8aa51e", "start_time": 1744285427529, "action_name_zh": "受理事件", "action_name_en": "Handling an incident", "status": "INCIDENT_STATUS_ACKNOWLEDGED", "enum_data_list": [ { "name_zh": "COC-Script", "name_en": "COC-Script", "biz_id": "653989085ba7487184d7cf219b8aa51e", "prop_id": "operator" } ] }, { "action_id": "main", "comment": "Create project f****elling. ", "start_time": 1744252838982, "stop_time": 1744285427529, "action_name_zh": "响应预案自动执行失败", "action_name_en": "响应预案自动执行失败", "status": "INCIDENT_STATUS_TRIGGERED", "enum_data_list": [ ] }, { "action": "create_incident", "start_time": 1744252838667, "stop_time": 1744252838982, "action_name_zh": "创建事件单", "action_name_en": "create incident", "status": "INCIDENT_STATUS_TRIGGERED", "enum_data_list": [ ] } ] } }

响应参数 状态码：200 表3 响应Body参数列表 名称 类型 是否必选 描述 provider_code String 否 服务标识。 缺省值：049 最小长度：0 最大长度：256 error_code String 否 请求响应代码，范围：0000~9999，正常时取值：0。 缺省值：0 最小长度：0 最大长度：256 error_msg String 否 请求响应描述。 最小长度：0 最大长度：256 data.title Long 否 总数。 最小值：1 最大值：9999999999999 data.info Arrays of CocTicketHistoryBaseInfo 否 历史信息列表。 数组长度：0 - 1024 表4 CocTicketHistoryBaseInfo参数列表 名称 类型 是否必选 描述 action String 否 Action操作类型。 最小长度：0 最大长度：255 默认取值：不涉及 action_name_zh String 否 Action中文名称。 最小长度：0 最大长度：255 默认取值：不涉及 action_name_zh String 否 Action英文名称。 最小长度：0 最大长度：255 默认取值：不涉及 operator String 否 操作人ID。 最小长度：0 最大长度：255 默认取值：不涉及 status String 否 当前状态。 最小长度：0 最大长度：255 默认取值：不涉及 start_time Long 否 操作开始时间。 最小值：1 最大值：9999999999999 默认取值：不涉及 stop_time Long 否 操作结束时间。 最小值：1 最大值：9999999999999 默认取值：不涉及 comment String 否 备注信息。 最小长度：0 最大长度：255 默认取值：不涉及 enum_data_list Arrays of TicketInfoEnumData 否 枚举列表。 数组长度：0 - 1024 表5 TicketInfoEnumData参数列表 名称 类型 是否必选 描述 prop_id String 否 字段KEY，标识哪个字段。 最小长度：0 最大长度：255 默认取值：不涉及 biz_id String 否 枚举KEY。 最小长度：0 最大长度：255 默认取值：不涉及 name_zh String 否 中文名称。 最小长度：0 最大长度：255 默认取值：不涉及 name_en String 否 英文名称。 最小长度：0 最大长度：255 默认取值：不涉及

响应示例 状态码：200 请求成功。 更多状态码请参考状态码。 { "provider_code": "049", "error_code": "GOM.00000000", "error_msg": null, "data": { "total": 1161, "tickets": [ { "current_cloud_service_id": "66431ed6ffed4e034ce18ff0", "level_id": "level_30", "mtm_region": "", "source_id": "incident_source_forwarding", "forward_rule_id": "1ccf2d2ae38b157ff103e84d710a9509", "enterprise_project_id": "0", "mtm_type": "inc_type_p_ohter_issues", "emergency_plan_type": "JOB", "emergency_plan_id": "RB20240527095644019f8019h", "emergency_plan_category": "COMMUNAL", "attachment": "", "title": " CES 自动执行响应预案_事件06", "description": "Condit****inutes", "handle_time": 315, "is_service_interrupt": false, "ticket_id": "IM202504101040380143525888", "assignee": "653989085ba7487184d7cf219b8aa51e", "work_flow_status": "INCIDENT_STATUS_TRIGGERED", "phase": "phase_incident_create", "enum_data_list": [ { "name_zh": "testApp1", "name_en": "testApp1", "biz_id": "66431ed6ffed4e034ce18ff0", "prop_id": "current_cloud_service_id", "model_id": "TicketInfo" }, { "name_zh": "CES自动执行响应预案_事件06", "name_en": "CES自动执行响应预案_事件06", "biz_id": "1ccf2d2ae38b157ff103e84d710a9509", "prop_id": "forward_rule_id" }, { "name_zh": "P3", "name_en": "P3", "biz_id": "level_30", "prop_id": "level_id" }, { "name_zh": "未受理", "name_en": "TRIGGERED", "biz_id": "INCIDENT_STATUS_TRIGGERED", "prop_id": "work_flow_status" }, { "name_zh": "其他", "name_en": "ohter issues", "biz_id": "inc_type_p_ohter_issues", "prop_id": "mtm_type" }, { "name_zh": "流转创建", "name_en": "Transfer creation", "biz_id": "incident_source_forwarding", "prop_id": "source_id" }, { "name_zh": "COC-Script", "name_en": "COC-Script", "biz_id": "653989085ba7487184d7cf219b8aa51e", "prop_id": "assignee" } ], "update_time": 1744252838924, "create_time": 1744252838072 } ] } } 状态码：400 服务器未能处理请求。 更多状态码请参考状态码。 { "error_code" : "GOM.00007256", "error_msg" : "参数错误", "provider_code" : "049", "data" : null }

请求示例 查询事件列表。 POST https://{Endpoint}/v2/incidents/list { "page": 1, "per_page": 10, "sort_filter": { "operator": "desc", "field": "create_time", "name": "create_time", "values": [ "create_time" ] }, "string_filters": [ { "operator": "in", "field": "assignee", "name": "assignee_default", "values": [ "653989085ba7487184d7cf219b8aa51e" ] }, { "operator": "in", "field": "approver", "name": "approver_default", "values": [ "653989085ba7487184d7cf219b8aa51e" ] }, { "operator": "in", "field": "work_flow_status", "name": "work_flow_status_default", "values": [ "incident_draft", "INCIDENT_STATUS_ACKNOWLEDGED", "INCIDENT_STATUS_REJECTED", "INCIDENT_STATUS_RESOLVED", "INCIDENT_STATUS_TRIGGERED", "pausing", "level_approving" ] }, { "operator": "in", "field": "work_flow_status", "name": "work_flow_status_approve", "values": [ "level_approving", "pause_approving" ] } ], "contain_total": true, "condition": "(work_flow_status_default & assignee_default) | (approver_default & work_flow_status_approve)" }

响应参数 状态码：200 表3 响应Body参数列表 名称 类型 是否必选 描述 provider_code String 否 服务标识。 缺省值：049 最小长度：0 最大长度：256 error_code String 否 请求响应代码，范围：0000~9999，正常时取值：0。 缺省值：0 最小长度：0 最大长度：256 error_msg String 否 请求响应描述。 最小长度：0 最大长度：256 data ListIncidentsResponseBodyData 否 搜索结果。 表4 ListIncidentsResponseBodyData参数列表 名称 类型 是否必选 描述 total Long 否 总数。 默认值：0 最小值：1 最大值：9999999999999 tickets Arrays of IncidentDataInfo 否 结果数据列表。 数组长度：1 - 1024 表5 IncidentDataInfo参数列表 名称 类型 是否必选 描述 current_cloud_service_id Long 否 云服务ID。 最小值：1 最大值：9999999999999 默认取值：不涉及 level_id String 否 事件等级。 最小长度：0 最大长度：255 默认取值：不涉及 mtm_region String 否 区域Region。 最小长度：0 最大长度：255 默认取值：不涉及 source_id String 否 事件来源。 最小长度：0 最大长度：255 默认取值：不涉及 forward_rule_id String 否 转发规则。 最小长度：0 最大长度：255 默认取值：不涉及 enterprise_project_id String 否 企业应用。 最小长度：0 最大长度：255 默认取值：不涉及 mtm_type String 否 事件类别。 最小长度：0 最大长度：255 默认取值：不涉及 title String 否 事件标题。 最小长度：0 最大长度：255 默认取值：不涉及 description String 否 事件描述。 最小长度：0 最大长度：255 默认取值：不涉及 ticket_id String 否 事件单号。 最小长度：0 最大长度：255 默认取值：不涉及 is_service_interrupt String 否 服务是否中断。 取值：true、false 最小长度：0 最大长度：255 默认取值：不涉及 work_flow_status String 否 流程状态。 最小长度：0 最大长度：255 默认取值：不涉及 phase String 否 流程阶段。 最小长度：0 最大长度：255 默认取值：不涉及 assignee String 否 责任人。 最小长度：0 最大长度：255 默认取值：不涉及 creator String 否 创建人。 最小长度：0 最大长度：255 默认取值：不涉及 operator String 否 最后一次操作人。 最小长度：0 最大长度：255 默认取值：不涉及 update_time Long 否 更新时间，时间戳。 最小值：1 最大值：9999999999 默认取值：不涉及 create_time Long 否 创建时间，时间戳。 最小值：1 最大值：9999999999 默认取值：不涉及 start_time Long 否 故障开始时间，时间戳。 最小值：1 最大值：9999999999 默认取值：不涉及 handle_time Long 否 处理时间，时间戳。 最小值：1 最大值：9999999999 默认取值：不涉及 incident_ownership String 否 事件归属。 最小长度：0 最大长度：255 默认取值：不涉及 enum_data_list Arrays of TicketInfoEnumData 否 枚举列表。 数组长度：1 - 1024 默认取值：不涉及 表6 TicketInfoEnumData参数列表 名称 类型 是否必选 描述 prop_id String 否 字段KEY标识哪个字段。 最小长度：0 最大长度：255 默认取值：不涉及 biz_id String 否 枚举KEY。 最小长度：0 最大长度：255 默认取值：不涉及 name_zh String 否 中文名称。 最小长度：0 最大长度：255 默认取值：不涉及 name_en String 否 英文名称。 最小长度：0 最大长度：255 默认取值：不涉及

响应示例 状态码：200 响应。 { "data" : [ { "id" : "64a5241aaef0294cfc45e968", "name" : "ng_test_app", "code" : "ng_test_app", "description" : "null", "domain_id" : "87ee79a270314bdb8b4749f3004e3685", "parent_id" : "null", "path" : "64a5241aaef0294cfc45e968", "is_collection" : true, "create_time" : "2023-07-05T08:04:42.817+00:00", "update_time" : "2025-02-21T08:31:38.799+00:00" } ] } 状态码：400 包含错误信息 { "error_code" : "COC.00101004", "error_msg" : "limit exceeds the maximum." }

URI GET /v1/applications 表1 Query参数 参数 是否必选 参数类型 描述 id_list 否 Array of strings 资源ID列表，可填多个。 parent_id 否 String 父节点ID。 code 否 String 应用代码。 name_like 否 String 应用名称，模糊查询。 marker 否 String 分页参数，通过上一个请求中返回的marker信息（应用ID）作为输入，获取当前页。 limit 是 Integer 返回数量限制。最小返回数量:1，最大返回数量:100。

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 data Array of data objects 应用列表。 表3 data 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 code String 应用代码。 domain_id String IAM租户的账号ID。 parent_id String 应用父节点ID。 description String 应用描述信息。 path String 应用层级路径，由ID拼接。 is_collection Boolean 是否为收藏应用。 create_time String 创建时间。 update_time String 修改时间。 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码：200 表15 响应Body参数列表 名称 类型 是否必选 描述 provider_code String 否 服务标识。 缺省值：049 最小长度：0 最大长度：256 error_code String 否 请求响应代码，范围：0000~9999，正常时取值：0。 缺省值：0 最小长度：0 最大长度：256 error_msg String 否 请求响应描述。 最小长度：0 最大长度：256

请求示例 未受理转发责任人 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "unAcceptedForward", "params": { "virtual_send_comment": "备注信息", "virtual_current_location_info": "定位***", "virtual_send_assignee": "bae47db0f86c48318ea65f10bd8aa417" } } 受理后转发责任人 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": " acceptedForward", "params": { "virtual_send_comment": "备注信息", "virtual_current_location_info": "定位***", "virtual_send_assignee": "bae47db0f86c48318ea65f10bd8aa417" } } 受理 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": " accepted" } 添加备注 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "addRemark", "params": { "note": "备注信息" } } 处理 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "commitSolution", "params": { "mtm_type": "inc_type_p_middleware_issues", "is_service_interrupt": false, "start_time": null, "fault_recovery_time": null, "cause": "222", "solution": "2222", "resolve_attachments": "" } } 验证关闭 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "confirm", "params": { "virtual_confirm_result": true, "virtual_confirm_comment": "备注信息" } } 申请暂停事件 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "incidentPause", "params": { "pause_end_time": 1744270013000, "pause_reason": "暂停原因" } } 暂停审批同意 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "agreed", "params": { "pause_approve_conclusion": true, "note": "备注信息" } } 暂停审批驳回 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "rejected", "params": { "pause_approve_conclusion": false, "note": "审批理由" } } 暂停恢复 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": " recovery" } 升降级申请 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "changeLevel", "params": { "virtual_target_level": "level_30", "virtual_change_level_comment": "【业务影响】：2\n【升降级理由】：3333" } } 升降级审批同意 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "agreed", "params": { "conclusion": true, "note": "备注信息" } } 升降级审批驳回 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "rejected", "params": { "conclusion": false, "note": "备注信息" } } 未受理驳回 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "rejected", "params": { "virtual_confirm_comment": "驳回缘由" } } 驳回重新开启 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "ReOpen", "params": { "mtm_region": "br-cto-beta", "enterprise_project_id": "0", "current_cloud_service_id": "653f911cfab10c5b1dd33c3a", "level_id": "level_40", "is_service_interrupt": true, "mtm_type": "inc_type_p_monitoring_issues", "title": "22", "description": "22", "attachments": "", "source_id": "incident_source_manual", "incident_ownership": "incident_ownership_100", "start_time": 1743674805160, "assignee": "bae47db0f86c48318ea65f10bd8aa417", "assignee_scene": "", "assignee_role": "" } } 驳回关单 POST https://{Endpoint}/v2/incidents/{incident_id}/action { "task_id": "{task_id}", "action": "agreed" }

请求示例 受理事件单。 https://{Endpoint}/v1/external/incident/handle { "incident_num" : "IM202403221515060171753781", "operator" : "7da46971b7e24eed90cf777cc2ff8b91", "operate_key" : "acceptedIncident1", "parameter" : { } } 提交事件单解决方案。 https://{Endpoint}/v1/external/incident/handle { "incident_num" : "IM202403221515060171753781", "operator" : "7da46971b7e24eed90cf777cc2ff8b91", "operate_key" : "commitSolution1", "parameter" : { "mtm_type" : "inc_type_p_config_issues", "is_service_interrupt" : true, "cause" : "100001", "solution" : "20001" } } 验证事件处理结果。 https://{Endpoint}/v1/external/incident/handle { "incident_num" : "IM202403221515060171753781", "operator" : "7da46971b7e24eed90cf777cc2ff8b91", "operate_key" : "confirm", "parameter" : { "virtual_confirm_result" : false, "virtual_confirm_comment" : "13" } }

响应示例 状态码：200 请求成功。 更多状态码请参考状态码。 { "error_code" : "GOM.00000000", "error_msg" : null, "provider_code" : "049", "data" : null } 状态码：400 服务器未能处理请求。 更多状态码请参考状态码。 { "error_code" : "GOM.00007256", "error_msg" : "参数错误", "provider_code" : "049", "data" : null }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 provider_code String 服务标识。 缺省值：049 最小长度：3 最大长度：100000000 error_code String 请求响应代码，范围：GOM.00000000~GOM.00009999999，正常时取值：GOM.00000000。 缺省值：GOM.00000000 最小长度：1 最大长度：15 error_msg String 请求响应描述。 最小长度：0 最大长度：100000000 data Object 执行不同动作后返回信息，当前固定为null 状态码：400 表3 响应Body参数 参数 参数类型 描述 provider_code String 服务标识。 缺省值：049 最小长度：3 最大长度：100000000 error_code String 请求响应代码，范围：GOM.00000000~GOM.00009999999，正常时取值：GOM.00000000。 缺省值：GOM.00000000 最小长度：1 最大长度：15 error_msg String 请求响应描述。 最小长度：0 最大长度：100000000

请求示例 https://{endpoint}/v1/external/warrooms { "war_room_name" : "测试001", "description" : "描述001", "region_code_list" : [ "region_code1", "region_code2" ], "application_id_list" : [ "CS10004308" ], "incident_number" : "IM202504101040150000000000", "participant" : "user_id", "war_room_admin" : "user_id", "schedule_group" : [ { "role_id" : "role_id1", "scene_id" : "scene_id1" } ], "application_names" : [ "COC" ], "region_names" : [ "华北-北京四" ], "enterprise_project_id" : 0, "notification_type" : "WECHAT" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 provider_code String 服务标识。 缺省值：4 最小长度：3 最大长度：3 error_code String 请求响应代码，为8位数字组成，前四位标记当前服务为warroom服务，后四位标记错误类型。 最小长度：8 最大长度：8 error_msg String 请求响应描述。 最小长度：0 最大长度：10240 data String warroom Id 最小长度：0 最大长度：255 状态码：400 表4 响应Body参数 参数 参数类型 描述 provider_code String 服务标识。 缺省值：049 最小长度：3 最大长度：3 error_code String 请求响应代码，为8位数字组成，前四位标记当前服务为warroom服务，后四位标记错误类型。 最小长度：8 最大长度：8 error_msg String 请求响应异常时报错信息。 最小长度：0 最大长度：10240 data Object 响应数据。

响应示例 状态码：200 成功响应 { "error_code" : "COC.00080000", "error_msg" : "success", "data" : "WR202504110000000000000000", "provider_code" : "049" } 状态码：400 创建失败 { "error_code" : "common.01010001", "error_msg" : "Token missing or invalid.", "data" : null, "provider_code" : "049" }