All Products
Search

This Product

    Security Center:DescribeImageBaselineCheckResult

    Document Center

    Security Center:DescribeImageBaselineCheckResult

    Last Updated:Nov 13, 2024

    Queries the security scan results of images.

    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:DescribeImageBaselineCheckResultget
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ImageUuidstringYes

    The UUID of the image.

    		a910053dd4710173ecc9e9d8931f****
    RiskLevelstringNo

    The severity of the image baseline that you want to query. Separate multiple severities with commas (,). By default, all valid values are used. Valid values:

    • high
    • medium
    • low
    		high,medium,low
    CriteriastringNo

    The search condition for the image baseline.

    		ak_leak
    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. 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
    ScanRangearrayNo

    The types of the assets that you want to scan.

    stringNo

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

    • image
    • container
    		image

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		24A20733-10A0-4AF6-BE6B-E3322413****
    PageInfoobject

    The pagination information.

    CurrentPageinteger

    The page number of the returned page.

    		1
    PageSizeinteger

    The number of entries returned per page.

    		20
    TotalCountinteger

    The total number of entries returned.

    		100
    Countinteger

    The number of entries returned on the current page.

    		10
    BaselineResultarray<object>

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

    BaselineResultobject

    The check results of the image baseline.

    Statusinteger

    The status of the baseline risks. Valid values:

    • 0: unfixed
    • 1: fixed
    		1
    LowRiskItemCountinteger

    The number of low-risk images that are affected.

    		10
    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.

    		1610304058301
    MiddleRiskItemCountinteger

    The number of medium-risk images that are affected.

    		1
    BaselineNameKeystring

    The key of the image baseline.

    		identification
    BaselineItemCountinteger

    The number of baseline check items.

    		5
    BaselineNameAliasstring

    The alias of the image baseline.

    		Identity authentication
    BaselineClassAliasstring

    The key of the image baseline type.

    		identification
    FirstScanTimelong

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

    		1610304058366
    HighRiskItemCountinteger

    The number of high-risk images that are affected.

    		1

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 10
  },
  "BaselineResult": [
    {
      "Status": 1,
      "LowRiskItemCount": 10,
      "BaselineNameLevel": "high",
      "LastScanTime": 1610304058301,
      "MiddleRiskItemCount": 1,
      "BaselineNameKey": "identification",
      "BaselineItemCount": 5,
      "BaselineNameAlias": "Identity authentication\n",
      "BaselineClassAlias": "identification",
      "FirstScanTime": 1610304058366,
      "HighRiskItemCount": 1
    }
  ]
}

    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
    2024-09-24The Error code has changedView Change Details