Querying the Security Check Report List of a Cluster

Function

This API is used to query the security check report list of a cluster.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/security-check/containers/cluster-reports

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
cluster_name	No	String	Definition Cluster name Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
cluster_id	No	String	Definition Cluster ID Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
cluster_category	No	String	Definition Cluster type Constraints N/A Range CCE: CCE standard clusters Turbo: CCE Turbo clusters Default Value N/A
severity	No	String	Definition Risk level. Constraints N/A Range Security: No risks. Insecurity: There are risks. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_num	Long	Definition Total number of clusters Range N/A
data_list	Array of SecurityCheckClusterReports objects	Definition Security check report list Range N/A

**Table 4** SecurityCheckClusterReports
Parameter	Type	Description
report_id	String	Definition Health check report ID Range N/A
cluster_name	String	Definition Cluster name Range N/A
cluster_id	String	Definition Cluster ID Range N/A
cluster_category	String	Definition Cluster type Range CCE: CCE standard clusters Turbo: CCE Turbo clusters
severity	String	Definition Risk level. Range Security: No risks. Insecurity: There are risks.
local_image_vul_num	Integer	Definition Number of local image vulnerabilities. Range N/A
risk_config_num	Integer	Definition Number of baseline risks. Range N/A
privileged_container_num	Integer	Definition Number of privileged container alarms. Range N/A
scan_time	Long	Definition Last scan time. Range N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "report_id" : "288d4f2e-8c4e-438a-8c14-be350a",
    "cluster_name" : "clusterName",
    "cluster_id" : "43411c30-450b-11f0-a624-0251b7",
    "cluster_category" : "CCE",
    "severity" : "Insecurity",
    "local_image_vul_num" : 1,
    "risk_config_num" : 0,
    "privileged_container_num" : 0,
    "scan_time" : 1755505273836
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Security Operations

Previous topic: Querying the Security Check Report Information of a Cluster

Next topic: Querying the Security Check Report of a Specified Server

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot