All Products
Search

This Product

    Security Center:DescribeImageListWithBaselineName

    Document Center

    Security Center:DescribeImageListWithBaselineName

    Last Updated:Nov 13, 2024

    Queries the details about images in the results of image baseline checks.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    BaselineNameKeystringYes

    The name of the image baseline.

    		ak_leak
    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
    RepoInstanceIdstringNo

    The instance ID of the image repository.

    		i-qewqrqcsadf****
    RepoNamestringNo

    The name of the image repository.

    		libssh2
    RepoNamespacestringNo

    The namespace to which the image repository belongs.

    		libssh2
    ImageDigeststringNo

    The SHA-256 value of the image digest.

    		2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423
    PageSizeintegerNo

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

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

    The ID of the container cluster.

    Note You can call the DescribeGroupedContainerInstances operation to query the IDs of container clusters.
    		cc20a1024011c44b6a8710d6f8b****
    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
    ContainerIdstringNo

    The ID of the container.

    		c08d5fc1a329a4b88950a253d082f****
    ClusterNamestringNo

    The name of the cluster.

    		docker-law
    PodstringNo

    The pod.

    		22222-7xsqq
    NamespacestringNo

    The namespace.

    		test-002
    ImagestringNo

    The name of the image to which the container belongs.

    		registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

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

    		5B8C2156-2DB9-5A42-99E7-F2ED5AE9EA1F
    PageInfoobject

    The pagination information.

    CurrentPageinteger

    The page number of the returned page. Default value: 1.

    		1
    PageSizeinteger

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

    		10
    TotalCountinteger

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

    		1
    Countinteger

    The number of the images returned on the current page.

    		1
    ImageInfosarray<object>

    The information about the images.

    ImageInfosobject

    The details about the image.

    MiddleRiskImageinteger

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

    		0
    RiskStatusstring

    Indicates whether the image is at risk. Valid values:

    • YES
    • NO
    		YES
    ImageCreatelong

    The timestamp when the image was created. Unit: milliseconds.

    		1636962328000
    Digeststring

    The SHA-256 value of the image digest.

    		2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423
    Tagstring

    The version of the image.

    		v1
    ImageUpdatelong

    The timestamp when the image was updated. Unit: milliseconds.

    		1636974116000
    InstanceIdstring

    The ID of the image instance.

    		cri-a595qp31knh9****
    LowRiskImageinteger

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

    		0
    RepoTypestring

    The type of the image repository.

    		PRIVATE
    RegionIdstring

    The region ID of the image instance.

    		cn-beijing
    Uuidstring

    The UUID of the image.

    		f58681174f944623345379e23b7b****
    ImageSizeinteger

    The size of the image.

    		157408623
    RepoIdstring

    The ID of the image repository.

    		crr-1lt6q7167yh6****
    TotalItemCountinteger

    The total number of risk items that are detected on the image by using the baseline.

    		3
    HighRiskImageinteger

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

    		1
    NoRiskImageinteger

    The number of images that do not have baseline risks.

    		0
    ImageIdstring

    The ID of the image.

    		cddb5fd33b34a1fabb358d0a19497cdfe362fe624821cb250947af0ea5cc****
    RepoNamestring

    The name of the image repository.

    		scanner
    ClusterIdstring

    The ID of the cluster.

    		c08d5fc1a329a4b88950a253d082f1****
    ClusterNamestring

    The name of the cluster.

    		docker-law
    RepoNamespacestring

    The namespace to which the image repository belongs.

    		libssh2
    Podstring

    The pod.

    		22222-7xsqq
    Namespacestring

    The namespace.

    		test-002
    ContainerIdstring

    The ID of the container.

    		04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****
    Imagestring

    The name of the image.

    		registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****
    InstanceNamestring

    The instance name of the server.

    		pre.mongo-196
    InternetIpstring

    The public IP address of the server.

    		47.96.XX.XX
    IntranetIpstring

    The private IP address of the server.

    		172.16.XX.XX
    TargetNamestring

    The name of the asset on which the baseline check is performed.

    		spod
    TargetIdstring

    The ID of the asset on which the baseline check is performed.

    		m-bp17m0pc0xprzbwo****
    TargetTypestring

    The type of the asset on which the baseline check is performed. Valid values:

    • ECS_IMAGE
    • ECS_SNAPSHOT
    		ECS_IMAGE
    LastScanTimelong

    The timestamp when the last baseline check was performed. Unit: milliseconds.

    		1649814050000
    FirstScanTimelong

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

    		1649814050000

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "5B8C2156-2DB9-5A42-99E7-F2ED5AE9EA1F",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "Count": 1
  },
  "ImageInfos": [
    {
      "MiddleRiskImage": 0,
      "RiskStatus": "YES",
      "ImageCreate": 1636962328000,
      "Digest": "2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423",
      "Tag": "v1",
      "ImageUpdate": 1636974116000,
      "InstanceId": "cri-a595qp31knh9****",
      "LowRiskImage": 0,
      "RepoType": "PRIVATE",
      "RegionId": "cn-beijing",
      "Uuid": "f58681174f944623345379e23b7b****",
      "ImageSize": 157408623,
      "RepoId": "crr-1lt6q7167yh6****",
      "TotalItemCount": 3,
      "HighRiskImage": 1,
      "NoRiskImage": 0,
      "ImageId": "cddb5fd33b34a1fabb358d0a19497cdfe362fe624821cb250947af0ea5cc****",
      "RepoName": "scanner",
      "ClusterId": "c08d5fc1a329a4b88950a253d082f1****",
      "ClusterName": "docker-law",
      "RepoNamespace": "libssh2",
      "Pod": "22222-7xsqq",
      "Namespace": "test-002",
      "ContainerId": "04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****",
      "Image": "registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****",
      "InstanceName": "pre.mongo-196",
      "InternetIp": "47.96.XX.XX",
      "IntranetIp": "172.16.XX.XX",
      "TargetName": "spod",
      "TargetId": "m-bp17m0pc0xprzbwo****",
      "TargetType": "ECS_IMAGE",
      "LastScanTime": 1649814050000,
      "FirstScanTime": 1649814050000
    }
  ]
}

    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-05-30The response structure of the API has changedView Change Details
    2022-09-19The response structure of the API has changedView Change Details
    2022-01-18Add OperationView Change Details