Help Center/ Cloud Operations Center/ API Reference/ API/ Patch management/ Querying Compliance Report Details
Updated on 2024-07-26 GMT+08:00
View PDF
Share

Querying Compliance Report Details

Function

This API is used to obtain the patch details of a node by page.

URI

GET /v1/patch/instance/compliant/{instance_compliant_id}

Table 1 URI parameters

Parameter

Mandatory or Not

Type

Description

instance_compliant_id

Yes

String

Compliance report ID
Table 2 Query parameters

Parameter

Mandatory or Not

Type

Description

offset

No

Integer

Offset

Minimum value: 1

Maximum value: 1000000

Default value: 1

limit

No

Integer

Number of records on each page

Minimum value: 1

Maximum value: 100

Default value: 10

title

No

String

Patch name

sort_dir

No

String

Sorting order

  • asc: The query results are displayed in the ascending order.
  • desc: The query results are displayed in the descending order.

sort_key

No

String

Sorting field: installed_time (patch installation time)

patch_status

No

String

Patch status. The options are as follows: INSTALLED (installed), INSTALLED_OTHER (Other patches have been installed.), MISSING(missing), REJECT (rejected), FAILED (failed), PENDING_REBOOT (installed and to be restarted).

classification

No

String

Category

severity_level

No

String

Severity level

compliance_level

No

String

Compliance level

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Long

Total number of records

compliance_items

Array of ComplianceItem objects

Patch compliance information

Array length: 0 to 1,000 elements
Table 4 ComplianceItem

Parameter

Type

Description

instance_id

String

Node ID

title

String

Patch name

classification

String

Category

severity_level

String

Severity level

compliance_level

String

Compliance level

patch_detail

PatchDetail object

Patch details
Table 5 PatchDetail

Parameter

Type

Description

installed_time

Long

Installation time

patch_baseline_id

String

Patch baseline ID

patch_baseline_name

String

Patch baseline name

patch_status

String

Patch status

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

Minimum length: 8 characters

Maximum length: 64 characters

error_msg

String

Error description

Minimum length: 2 characters

Maximum length: 512 characters

Request Example

Requests patch information in a specified report

/v1/patch/instance/compliant/3f5f3c944f50da3a7038457c5ff76c66?offset=1&limit=10

Response Example

Status code: 200

Node patch information is returned.

{
  "count" : 1,
  "compliance_items" : [ {
    "classification" : "",
    "compliance_level" : "UNSPECIFIED",
    "instance_id" : "string",
    "patch_detail" : {
      "installed_time" : 1713864585000,
      "patch_baseline_id" : "JX-f2d85e2554f7385cbbf2c23a01f41",
      "patch_baseline_name" : "COC-EulerOSDefaultPatchBaseline",
      "patch_status" : "PENDING_REBOOT"
    },
    "severity_level" : "",
    "title" : "string"
  } ]
}

Status code: 500

An error message is returned.

{
  "error_code" : "string",
  "error_msg" : "string"
}

Status Code

Status Code

Description

200

Node patch information is returned.

500

An error message is returned.
Parent topic: Patch management