All Products
Search
Document Center

Security Center:DescribeImageBaselineCheckSummary

Last Updated:Feb 20, 2024

Queries the check results of image baselines that are included in an image scan task.

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
yundun-sas:DescribeImageBaselineCheckSummaryRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RiskLevelstringNo

The severity of the image baseline that you want to query. Separate multiple severities with commas (,). Valid values:

  • high
  • medium
  • low
high
CriteriastringNo

The search condition for the image baseline.

Unauthorized access
CriteriaTypestringNo

The type of the search condition. Valid values:

  • BaselineNameAlias: baseline name
  • BaselineClassAlias: baseline category
BaselineNameAlias
PageSizeintegerNo

The number of entries to return on each page. Default value: 20.

20
CurrentPageintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
ClusterIdstringNo

The ID of the specified container cluster.

Note You can call the DescribeGroupedContainerInstances operation to query the ID of the container cluster.
c60b77fe62093480db6164a3c2fa5****
ScanRangearrayNo

The types of the assets that you want to scan.

stringNo

The type of the asset that you want to scan. Valid values:

  • container
  • image
container

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

5BD95679-D63A-4151-97D0-188432F4A57
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page. Default value: 20.

20
TotalCountinteger

The total number of entries returned.

3
Countinteger

The number of entries returned on the current page.

3
BaselineResultSummaryobject []

An array that consists of the check results of image baselines.

Statusinteger

The status of the baseline risks. Valid values:

  • 0: unfixed
  • 1: fixed
  • 2: pending verification
  • 3: fixing failed
0
MiddleRiskImageinteger

The number of images on which medium baseline risks are detected.

0
BaselineNameLevelstring

The severity of the image baseline. Valid values:

  • high
  • medium
  • low
high
LastScanTimelong

The timestamp generated when the last scan was performed. Unit: milliseconds.

1626628760000
HighRiskImageinteger

The number of images on which high baseline risks are detected.

15
BaselineNameKeystring

The keyword of the baseline name.

hc_image_exploit
BaselineClassKeystring

The keyword of the baseline category.

hc_image_exploit
BaselineNameAliasstring

The name of the baseline.

Unauthorized access
BaselineClassAliasstring

The category of the baseline.

Unauthorized access
FirstScanTimelong

The timestamp generated when the first scan was performed. Unit: milliseconds.

1626628760000
LowRiskImageinteger

The number of images on which low baseline risks are detected.

0

Examples

Sample success responses

JSONformat

{
  "RequestId": "5BD95679-D63A-4151-97D0-188432F4A57",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 3,
    "Count": 3
  },
  "BaselineResultSummary": [
    {
      "Status": 0,
      "MiddleRiskImage": 0,
      "BaselineNameLevel": "high",
      "LastScanTime": 1626628760000,
      "HighRiskImage": 15,
      "BaselineNameKey": "hc_image_exploit",
      "BaselineClassKey": "hc_image_exploit",
      "BaselineNameAlias": "Unauthorized access",
      "BaselineClassAlias": "Unauthorized access",
      "FirstScanTime": 1626628760000,
      "LowRiskImage": 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.

Change history

Change timeSummary of changesOperation
2022-09-16The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ScanRange
2022-09-16The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ScanRange
2022-01-18Add Operationsee changesets