All Products
Search
Document Center

Container Service for Kubernetes:DescribeNodePoolVuls

Last Updated:Apr 22, 2024

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeNodePoolVulsRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#cluster_id}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
necessitystringNo

The priority to fix the vulnerability. Separate multiple priorities with commas (,). Valid values:

  • asap: high
  • later: medium
  • nntf: low
asap

Response parameters

ParameterTypeDescriptionExample
object
vul_recordsobject []

The node pool vulnerabilities.

instance_idstring

The node ID.

i-t4n2qolb0wtzt0pz****
vul_listobject []

A list of vulnerabilities.

namestring

The name of the vulnerability.

oval:com.redhat.rhsa:def:20193197
alias_namestring

The alias of the vulnerability.

RHSA-2019:3197-Important: sudo security update
necessitystring

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
asap
cve_listarray

A list of CVE names corresponding to the vulnerabilities.

string

The CVE name of the vulnerability.

CVE-2017-10268
node_namestring

The node name. This name is the identifier of the node in the cluster.

cn-hangzhou.192.168.x.x

Examples

Sample success responses

JSONformat

{
  "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"
          ]
        }
      ],
      "node_name": "cn-hangzhou.192.168.x.x"
    }
  ],
  "vuls_fix_service_purchased": false
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history