All Products
Search
Document Center

Security Center:DescribeClusterImageSecuritySummary

Last Updated:Nov 14, 2024

Queries the statistical information about image 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
yundun-sas:DescribeClusterImageSecuritySummaryget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address.

60.190.XXX.XXX
ClusterIdstringNo

The ID of the cluster.

c3aaf6c8085f84791882eef200cd2****
ContainerFieldNamestringNo

The key of the condition that is used to query containers. Valid values:

  • instanceId: the instance ID of the container
  • clusterId: the ID of the cluster
  • regionId: the region ID of the container
  • clusterName: the name of the cluster
  • image: the name of the image
  • imageRepoName: the name of the image repository
  • imageRepoNamespace: the namespace to which the image repository belongs
  • imageRepoTag: the tag that is added to the image repository
  • imageDigest: the digest of the image
  • clusterType: the type of the cluster
  • hostIp: the public IP address
  • pod: the pod
  • podIp: the IP address of the pod
  • containerId: the ID of the container
  • vulStatus: whether vulnerabilities are detected on the container
  • alarmStatus: whether alerts are generated for the container
  • riskStatus: whether risks are detected on the container
  • riskLevel: the risk level of the container
  • containerScope: the type of the container
clusterId
ContainerFieldValuestringNo

The value of the condition that is used to query containers.

c2ac28b2d0c734df29a21d29f18ac****
ImageRepoNamestringNo

The name of the image repository.

repo
ImageRepoNamespacestringNo

The namespace of the image repository.

namespace
ImageTagstringNo

The tag of the image.

3.54.0.1
ImageDigeststringNo

The digest of the image.

402902de6480a020b9f29e7105e77b8a218bc1cccbc3935d3b38c8ea9ba2****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

F8B6F758-BCD4-597A-8A2C-DA5A552C****
ClusterImageEventobject

The information about the image-related security events.

ImageCveVularray<object>

The information about image system vulnerabilities.

ImageCveVulobject
RiskLevelstring

The alert level. Valid values:

  • asap: high. You must fix the vulnerability at the earliest opportunity.
  • nntf: medium. You can fix the vulnerability based on your business requirements.
  • later: low. You can ignore the vulnerability.
later
Countlong

The number of vulnerabilities.

0
ImageMaliciousFilearray<object>

The information about malicious image samples.

ImageMaliciousFileobject
RiskLevelstring

The risk level. Valid values:

  • high
  • medium
  • low
medium
Countlong

The number of malicious samples.

0
ImageScaVularray<object>

The information about image application vulnerabilities.

ImageScaVulobject
RiskLevelstring

The alert level. Valid values:

  • asap: high. You must fix the vulnerability at the earliest opportunity.
  • nntf: medium. You can fix the vulnerability based on your business requirements.
  • later: low. You can ignore the vulnerability.
later
Countlong

The number of image application vulnerabilities.

0
ImageBaselinearray<object>

The information about image baseline risks.

ImageBaselineobject
RiskLevelstring

The risk level. Valid values:

  • high
  • medium
  • low
medium
Countlong

The number of baselines.

0

Examples

Sample success responses

JSONformat

{
  "RequestId": "F8B6F758-BCD4-597A-8A2C-DA5A552C****",
  "ClusterImageEvent": {
    "ImageCveVul": [
      {
        "RiskLevel": "later",
        "Count": 0
      }
    ],
    "ImageMaliciousFile": [
      {
        "RiskLevel": "medium",
        "Count": 0
      }
    ],
    "ImageScaVul": [
      {
        "RiskLevel": "later",
        "Count": 0
      }
    ],
    "ImageBaseline": [
      {
        "RiskLevel": "medium",
        "Count": 0
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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