Query node pool vulnerabilities with DescribeNodePoolVuls - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Queries the vulnerability information of a node pool, such as vulnerability names and severity levels, by specifying the ID of the node pool. We recommend that you periodically scan node pools for vulnerabilities to enhance cluster security.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:DescribeNodePoolVuls

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#cluster_id}

None

Request syntax

GET /clusters/{cluster_id}/nodepools/{nodepool_id}/vuls HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
cluster_id	string	Yes	Cluster ID.	c17e742cee942410486f237293d66****
nodepool_id	string	Yes	Node pool ID.	np38f32fdbc60e4a1e957ffde77846****

Request parameters

Parameter	Type	Required	Description	Example
necessity	string	No	The priority to fix the vulnerability. Separate multiple priorities with commas (,). Valid values: `asap`: high `later`: medium `nntf`: low	asap

Response elements

Element	Type	Description	Example
	object
vul_records	array<object>	The vulnerability list of all node pools.
	array<object>	The vulnerability list of a node pool.
instance_id	string	The ID of the node.	i-t4n2qolb0wtzt0pz****
vul_list	array<object>	The list of vulnerabilities.
	array<object>	The details about a vulnerability.
name	string	The name of the vulnerability.	oval:com.redhat.rhsa:def:20193197
alias_name	string	The alias of the vulnerability.	RHSA-2019:3197-Important: sudo security update
necessity	string	The severity level of the vulnerability. Valid values: nntf: You can ignore the vulnerability. later: You can fix the vulnerability later. asap: You need to fix the vulnerability at the earliest opportunity. Valid values: nntf : later : asap :	asap
cve_list	array	A list of CVE names corresponding to the vulnerabilities.
	string	The CVE name of the vulnerability.	CVE-2017-10268
need_reboot	boolean	Indicates whether a restart is required.	false
package_list	array<object>	List of packages affected by the vulnerability.
	object	Package information.
name	string	Package name.	WebLogic
node_name	string	The node name. This name is the identifier of the node in the cluster.	cn-hangzhou.192.168.x.x
vuls_fix_service_purchased	boolean	Indicates whether the CVE vulnerability patching service provided by Security Center is purchased. true: yes false: no	false

Examples

Success response

JSON format

{
  "vul_records": [
    {
      "instance_id": "i-t4n2qolb0wtzt0pz****",
      "vul_list": [
        {
          "name": "oval:com.redhat.rhsa:def:20193197",
          "alias_name": "RHSA-2019:3197-Important: sudo security update",
          "necessity": "asap",
          "cve_list": [
            "CVE-2017-10268"
          ],
          "need_reboot": false,
          "package_list": [
            {
              "name": "WebLogic"
            }
          ]
        }
      ],
      "node_name": "cn-hangzhou.192.168.x.x"
    }
  ],
  "vuls_fix_service_purchased": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.