All Products
Search
Document Center

Security Center:ListImageRisk

Last Updated:Jan 28, 2023

Queries security information about a container image.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The number of the page to return.

1
PageSizeintegerNo

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

20
ClusterIdstringNo

The ID of the container cluster.

NoteYou can call the DescribeGroupedContainerInstances operation to query the ID of the container cluster.
c80f79959fd724a888e1187779b13****
NamespacestringNo

The name of the namespace to which the repository belongs.

kube-sy****
AppNamestringNo

The name of the application.

e****
ImageNamestringNo

The name of the image.

container-***:****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

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

050ACC7A-D4FD-55C6-B861-BA9569C1****
ImageRiskListarray

An array that consists of security information about the image.

object

The security information about the image.

RepoNamespacestring

The name of the namespace to which the repository belongs.

vultar***
RepoNamestring

The name of the image repository.

scan_test
Tagstring

The tag that is added to the image.

0.1.0
RegionIdstring

The region of the image repository.

cn-hangzhou
Digeststring

The digest value of the image.

3f8efc2184cf1d24936b49c27286a284714b77be34c80c9ee38ca6bf322445****
RepoIdstring

The ID of the image repository.

crr-bk2l746eyxca1****
RepoTypestring

The type of the repository. Valid values:

  • PUBLIC
  • PRIVATE
PRIVATE
RegistryTypestring

The type of the image repository. Valid values:

  • acr
  • harbor
  • quay
  • CI/CD: Jenkins
harbor
Endpointsstring

The endpoint of Container Registry.

https://172.20.XXX.XXX/test
ImageIdstring

The ID of the image.

f922bfeb6960436fe3f0e7b62fc6b9a0b47980986669c367c22433269404****
TagImmutableinteger

Indicates whether the image version is immutable. If the image version is immutable, only the image of the latest version in the image repository can be overwritten. Valid values:

  • 0: The image version is mutable.
  • 1: The image version is immutable.
0
Statisticsstring

The statistics on a security event.

{ "baselineNum": 0, "newSuspicious": 0, "vul": 0 }
ImageAccessTypestring

The registration status of the image repository. Valid values:

  • IN_SAS: The image repository is registered with Security Center.
  • NOT_IN_SAS: The image repository is not registered with Security Center.
IN_SAS
Imagestring

The image of the container.

.aliyuncs.com/sas_test/baseline:exploit
Uuidstring

The UUID of the image.

624778f3-5bf2-423c-ac0c-47a62c05****
EndPointListarray

An array that consists of the details of the endpoint.

object

The information about the endpoint.

Domainsarray

An array that consists the details of the domain name in the endpoint.

string

The domain name in the endpoint.

****-registry-registry-intranet.cn-shenzhen.cr.aliyuncs.com
Typestring

The type of the domain name in the endpoint. Valid values:

  • internet: Internet
  • intranet: internal network
internet
InternetURLsstring

The public endpoint of the image repository.

****registry-registry.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****
VpcURLsstring

The endpoint of the image repository in the VPC.

****-registry-registry-vpc.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****
PageInfoobject

The pagination information.

TotalCountinteger

The total number of entries returned.

23
Countinteger

The number of entries returned on the current page.

3
PageSizeinteger

The number of entries returned per page.

20
CurrentPageinteger

The page number of the returned page.

1

Example

Normal return example

JSONFormat

{
  "RequestId": "050ACC7A-D4FD-55C6-B861-BA9569C1****",
  "ImageRiskList": [
    {
      "RepoNamespace": "vultar***",
      "RepoName": "scan_test",
      "Tag": "0.1.0",
      "RegionId": "cn-hangzhou",
      "Digest": "3f8efc2184cf1d24936b49c27286a284714b77be34c80c9ee38ca6bf322445****",
      "RepoId": "crr-bk2l746eyxca1****",
      "RepoType": "PRIVATE",
      "RegistryType": "harbor",
      "Endpoints": "https://172.20.XXX.XXX/test",
      "ImageId": "f922bfeb6960436fe3f0e7b62fc6b9a0b47980986669c367c22433269404****",
      "TagImmutable": 0,
      "Statistics": "{\n\t\"baselineNum\": 0,\n\t\"newSuspicious\": 0,\n\t\"vul\": 0\n}",
      "ImageAccessType": "IN_SAS",
      "Image": ".aliyuncs.com/sas_test/baseline:exploit",
      "Uuid": "624778f3-5bf2-423c-ac0c-47a62c05****",
      "EndPointList": [
        {
          "Domains": [
            "****-registry-registry-intranet.cn-shenzhen.cr.aliyuncs.com"
          ],
          "Type": "internet"
        }
      ],
      "InternetURLs": "****registry-registry.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****",
      "VpcURLs": "****-registry-registry-vpc.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****"
    }
  ],
  "PageInfo": {
    "TotalCount": 23,
    "Count": 3,
    "PageSize": 20,
    "CurrentPage": 1
  }
}

Error codes

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

For a list of error codes, visit the API error center.