All Products
Search
Document Center

Container Service for Kubernetes:DescribeClusterVuls

Last Updated:Nov 07, 2024

Queries the security vulnerability details of a cluster by cluster ID. The details include vulnerability name, vulnerability type, and vulnerability severity. We recommend that you scan your cluster on a regular basis to ensure cluster security.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeClusterVulsget
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringNo

The ID of the cluster.

c5cdf7e3938bc4f8eb0e44b21a80f****

Response parameters

ParameterTypeDescriptionExample
object

Response body

vul_recordsarray<object>

An array of vulnerabilities.

vul_recordobject
nodepool_namestring

The name of the node pool.

test
nodepool_idstring

The node pool ID.

np0156da1082b54fa987e32618dd45f5d3
node_countinteger

The number of nodes that have the vulnerability.

1
vul_namestring

The name of the vulnerability.

oval:com.redhat.rhsa:def:xxxxxxx
vul_alias_namestring

The alias of the vulnerability.

CVE-2022-xxxx:rsync Security vulnerabilities
vul_typestring

The type of vulnerability.

Valid values:

  • app: application vulnerabilities
  • sca: application vulnerabilities (software component analysis)
  • cve: Linux vulnerabilities
  • cms: Web-CMS vulnerabilities
  • sys: Windows vulnerabilities
  • emg: emergency vulnerabilities
cve
necessitystring

The severity level of the vulnerability.

Valid values:

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

The CVE list.

cvestring

The CVE information.

CVE-2022-xxxxx

Examples

Sample success responses

JSONformat

{
  "vul_records": [
    {
      "nodepool_name": "test",
      "nodepool_id": "np0156da1082b54fa987e32618dd45f5d3",
      "node_count": 1,
      "vul_name": "oval:com.redhat.rhsa:def:xxxxxxx",
      "vul_alias_name": "CVE-2022-xxxx:rsync Security vulnerabilities",
      "vul_type": "cve",
      "necessity": "asap",
      "cve_list": [
        "CVE-2022-xxxxx"
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history