Querying the List of Cluster Resources Affected by Cluster Risks

Function

This API is used to query the list of cluster resources affected by cluster risks.

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}/container/cluster/risk/{risk_id}/affected-resources

**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
risk_id	Yes	String	Risk ID

**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_id	No	String	Cluster ID.
resource_name	No	String	Resource name
resource_type	No	String	Resource type
namespace	No	String	Namespace to which the resource belongs

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Number of resources affected by cluster risks
data_list	Array of data_list objects	List of resources affected by cluster risks

**Table 5** data_list
Parameter	Type	Description
resource_name	String	Resource name.
resource_id	String	Resource ID.
resource_type	String	Resource type
namespace	String	Namespace to which the resource belongs.
hit_rule	String	Hit rule of a detected resource risk
hit_path_list	Array of strings	List of paths with resource risks
first_scan_time	Long	First scanned
last_scan_time	Long	Last scanned

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "resource_name" : "kube-apiserver-ecs-gph-k8s-master",
    "resource_id" : "02xxxxa3-1xx7-4xx0-8xxf-fffxxxxxxx88",
    "resource_type" : "Pod",
    "namespace" : "kube-system",
    "hit_rule" : "The API server container gphtest has insecure-port flag enabled",
    "hit_path_list" : [ "spec.containers[0].command[1]" ],
    "first_scan_time" : 1745311451000,
    "last_scan_time" : 1745311451000
  } ]
}