文档首页/ 云运维中心 COC/ API参考/ API/ 补丁管理/ 查询补丁合规性报告
更新时间：2024-07-04 GMT+08:00
查看PDF
分享

查询补丁合规性报告

功能介绍

分页获取节点合规性报告

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

偏移量

最小值：1

最大值：1000000

缺省值：1

limit

否

Integer

每页数量

最小值：1

最大值：100

缺省值：10

sort_dir

否

String

排序

  • asc：升序
  • desc：降序

sort_key

否

String

排序字段

  • report_time：报告时间

report_scene

否

String

报告场景

  • CCE
  • ECS

cce_info_id

否

String

cce 集群信息id

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

count

Long

总条数

instance_compliant

Array of InstanceCompliant objects

节点合规报告

数组长度：0 - 1000
表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

错误码

最小长度：8

最大长度：64

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

查询ECS报告下不合规的报告列表

/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" : 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

节点合规性报告信息

500

错误信息返回
父主题： 补丁管理

相关文档