# 获取节点合规性报告 - ListInstanceCompliant #### 功能介绍 分页获取节点合规性报告 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ListInstanceCompliant)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | coc:complianceReport:list | List | - | - | - | - | #### URI GET /v1/patch/instance/compliant 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释：** 企业项目ID。 **约束限制：** 若没有，请前往创建[企业管理](https://support.huaweicloud.com/usermanual-em/eps_13_0001.html#section6)中创建。 **取值范围：** 由小写字母（a\~z）、数字（0-9）、中划线（-）组成的长度为36的字符串，举例：c17bbc73-f1b4-7890-91f3-a3aa1234561a。 **默认取值：** 0。 | | name | 否 | String | **参数解释：** 资源名称，补丁扫描或补丁修复后的ECS/BMS实例名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 否 | String | **参数解释：** 资源ID，补丁扫描或补丁修复后的ECS/BMS实例ID。 **约束限制：** 不涉及。 **取值范围：** 由小写字母（a\~z）、数字（0-9）、中划线（-）组成的长度为36的字符串，举例：8c123456-e426-4cdd-b123-4e1e36e00f99。 **默认取值：** 不涉及。 | | ip | 否 | String | **参数解释：** ECS/BMS实例网卡的私有IP地址。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | eip | 否 | String | **参数解释：** ECS/BMS实例的弹性公网IP地址。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | operating_system | 否 | String | **参数解释：** ECS/BMS实例对应的操作系统。 **约束限制：** 不涉及。 **取值范围：** - HuaweiCloudEulerOS - CentOS - EulerOS **默认取值：** 不涉及。 | | region | 否 | String | **参数解释：** ECS/BMS实例所属的区域编号，区域名称与编号对应关系请查看[地区和终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | group | 否 | String | **参数解释：** ECS/BMS实例所属的应用分组名称，应用信息请查看[应用管理概述](https://support.huaweicloud.com/usermanual-coc/coc_um_03_02_18.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | compliant_status | 否 | String | **参数解释：** 合规性状态，若扫描后合规性报告中存在不合规补丁，则合规性状态显示为不合规，否则显示为合规。 **约束限制：** 不涉及。 **取值范围：** - non_compliant：不合规 - compliant：合规 **默认取值：** 不涉及。 | | order_id | 否 | String | **参数解释：** 补丁工单ID，创建补丁扫描或补丁修复时系统生成的补丁工单ID。 **约束限制：** 不涉及。 **取值范围：** 以"OST"开头，小写字母（a\~z）、数字（0-9）组成长度26的字符串。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 用于分页查询合规性报告，偏移指针。 **约束限制：** 不涉及。 **取值范围：** 整数，长度在1\~1000000之间。 **默认取值：** 1。 | | limit | 否 | Integer | **参数解释：** 用于分页查询合规性报告，每页查询数量。 **约束限制：** 不涉及。 **取值范围：** 整数，长度在1\~100之间。 **默认取值：** 10。 | | sort_dir | 否 | String | **参数解释：** 合规性报告排序方式。 **约束限制：** 不涉及。 **取值范围：** - asc：升序 - desc：降序 **默认取值：** 不涉及。 | | sort_key | 否 | String | **参数解释：** 排序字段，可选择按照哪些响应字段进行排序，与"sort_dir"参数配合使用。 **约束限制：** 不涉及。 **取值范围：** "report_time"（报告时间） **默认取值：** 不涉及。 | | report_scene | 否 | String | **参数解释：** 合规性报告的场景。 **约束限制：** 不涉及。 **取值范围：** - CCE - ECS - BMS **默认取值：** 不涉及。 | | cce_info_id | 否 | String | **参数解释：** CCE集群的ID。 **约束限制：** 不涉及。 **取值范围：** 由小写字母（a\~z）、数字（0-9）、中划线（-）组成的长度为36的字符串，举例：aad16bee-1234-11ef-affb-1234ac1234b6。 **默认取值：** 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Long | **参数解释：** 返回节点合规性报告总条数。 **取值范围：** 整数。 | | instance_compliant | Array of [InstanceCompliant] objects | **参数解释：** 节点合规性报告。 **取值范围：** 不涉及。 | 表3InstanceCompliant | 参数 | 参数类型 | 描述 | |:---|:---|:---| | compliant_summary | [CompliantSummary] object | **参数解释：** 合规补丁信息。 **取值范围：** 不涉及。 | | non_compliant_summary | [NonCompliantSummary] object | **参数解释：** 不合规补丁信息。 **取值范围：** 不涉及。 | | execution_summary | [ExecutionSummary] object | **参数解释：** 执行信息。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 合规性报告UUID。 **取值范围：** 由小写字母（a\~z）、数字（0-9）组成的长度为32的字符串，举例：c17bbc73f1b4789091f3a3aa1234561a。 | | enterprise_project_id | String | **参数解释：** 企业项目ID。 **取值范围：** 由小写字母（a\~z）、数字（0-9）、中划线（-）组成的长度为36的字符串，举例：c17bbc73-f1b4-7890-91f3-a3aa1234561a。 | | name | String | **参数解释：** 资源名称，补丁扫描或补丁修复后的ECS/BMS实例名称。 **取值范围：** 不涉及。 | | instance_id | String | **参数解释：** 资源ID，补丁扫描或补丁修复后的ECS/BMS实例ID。 **取值范围：** 由小写字母（a\~z）、数字（0-9）、中划线（-）组成的长度为36的字符串，举例：8c123456-e426-4cdd-b123-4e1e36e00f99。 | | node_id | String | **参数解释：** CCE集群中的ECS实例ID。 **取值范围：** 由小写字母（a\~z）、数字（0-9）、中划线（-）组成的长度为36的字符串，举例：aad16bee-1234-11ef-affb-1234ac1234b6。 | | ip | String | **参数解释：** ECS/BMS实例网卡的私有IP地址。 **取值范围：** 不涉及。 | | eip | String | **参数解释：** ECS/BMS实例的弹性公网IP地址。 **取值范围：** 不涉及。 | | region | String | **参数解释：** ECS/BMS实例所属的区域编号，区域名称与编号对应关系请查看[地区和终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint)。 **取值范围：** 不涉及。 | | group | String | **参数解释：** ECS/BMS实例所属的应用分组名称，应用信息请查看[应用管理概述](https://support.huaweicloud.com/usermanual-coc/coc_um_03_02_18.html)。 **取值范围：** 不涉及。 | | report_scene | String | **参数解释：** 合规性报告的场景。 **取值范围：** - CCE - ECS - BMS | | cce_info_id | String | **参数解释：** CCE集群的ID。 **取值范围：** 由小写字母（a\~z）、数字（0-9）、中划线（-）组成的长度为36的字符串，举例：aad16bee-1234-11ef-affb-1234ac1234b6。 | | status | String | **参数解释：** 合规性状态，若扫描后合规性报告中存在不合规补丁，则合规性状态显示为不合规，否则显示为合规。 **取值范围：** - non_compliant：不合规 - compliant：合规 | | baseline_id | String | **参数解释：** 基线ID。 **取值范围：** 由"JX-"开头，小写字母（a\~z）、数字（0-9）组成的长度为32的字符串，举例：JX-123456e9541f9b5775193ad3fb8a3。 | | baseline_name | String | **参数解释：** 基线名称。 **取值范围：** 不涉及。 | | rule_type | String | **参数解释：** 基线规则 **取值范围：** - standard：标准 - custom：自定义 | | operating_system | String | **参数解释：** ECS/BMS实例对应的操作系统。 **取值范围：** - HuaweiCloudEulerOS - CentOS - EulerOS | 表4CompliantSummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | compliant_count | Integer | **参数解释：** 返回的合规补丁数量。 **取值范围：** 整数。 | | severity_summary | [SeveritySummary] object | **参数解释：** 合规总结信息。 **取值范围：** 不涉及。 | 表5NonCompliantSummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | non_compliant_count | Integer | **参数解释：** 不合规补丁数量。 **取值范围：** 不涉及。 | | severity_summary | [SeveritySummary] object | **参数解释：** 合规总结信息。 **取值范围：** 不涉及。 | 表6SeveritySummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | critical_count | Integer | **参数解释：** 重大合规性报告数量。 **取值范围：** 整数。 | | high_count | Integer | **参数解释：** 高合规性报告数量。 **取值范围：** 整数。 | | informational_count | Integer | **参数解释：** 信息性合规性报告数量。 **取值范围：** 整数。 | | low_count | Integer | **参数解释：** 低合规性报告数量。 **取值范围：** 整数。 | | medium_count | Integer | **参数解释：** 中级合规性报告数量。 **取值范围：** 整数。 | | unspecified_count | Integer | **参数解释：** 未指定合规性报告数量。 **取值范围：** 整数。 | 表7ExecutionSummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order_id | String | **参数解释：** 补丁工单ID，创建补丁扫描或补丁修复时系统生成的补丁工单ID。 **取值范围：** 以"OST"开头，小写字母（a\~z）、数字（0-9）组成长度26的字符串。 | | job_id | String | **参数解释：** 执行脚本工单ID，具体执行的脚本工单ID。 **取值范围：** 以"SCT"开头，小写字母（a\~z）、数字（0-9）组成长度24的字符串。 | | report_time | Long | **参数解释：** 报告时间。 **取值范围：** 13位毫秒级UNIX时间戳。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 查询ECS场景报告下不合规的报告列表，每页返回10个记录，从第1页开始。 ``` GET https://coc.myhuaweicloud.com/v1/patch/instance/compliant?offset=1&limit=10&compliant_status=non_compliant&report_scene=ECS ``` #### 响应示例 **状态码：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" : "123:123:12:1", "enterprise_project_id" : "c17bbc73-f1b4-7890-91f3-a3aa1234561a", "execution_summary" : { "job_id" : "string", "order_id" : "OST2025060116450602a8asdf1", "report_time" : 1715308575000 }, "group" : null, "id" : "string", "instance_id" : "8c123456-e426-4cdd-b123-4e1e36e00f99", "ip" : "192.168.2.1", "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" : "cn-north-4", "report_scene" : "ECS", "rule_type" : "standard", "status" : "non_compliant" } ] } ``` **状态码：500** ``` { "error_code" : "string", "error_msg" : "string" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 节点合规性报告信息 | | 500 | 错误信息返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。