Call the ListImageRisk API to query container image security information - Security Center - Alibaba Cloud - Security Center

Retrieves the security information of container images.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListImageRisk

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The page number of the current page in a paging query.	1
PageSize	integer	No	The maximum number of entries per page in a paging query. Default value: 20.	20
ClusterId	string	No	The ID of the container cluster to query. Note You can call the DescribeGroupedContainerInstances operation to obtain this parameter.	c80f79959fd724a888e1187779b13****
Namespace	string	No	The image namespace.	kube-sy****
AppName	string	No	The application name.	e****
ImageName	string	No	The image name.	container-*:**

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	050ACC7A-D4FD-55C6-B861-BA9569C1****
ImageRiskList	array<object>	The list of image risk information.
	array<object>	The image risk information.
RepoNamespace	string	The image namespace.	vultar***
RepoName	string	The name of the image repository.	scan_test
Tag	string	The image tag.	0.1.0
RegionId	string	The region where the image repository resides.	cn-hangzhou
Digest	string	The digest value of the image.	3f8efc2184cf1d24936b49c27286a284714b77be34c80c9ee38ca6bf322445****
RepoId	string	The ID of the image repository.	crr-bk2l746eyxca1****
RepoType	string	The repository type. Valid values: `PUBLIC`: public `PRIVATE`: private.	PRIVATE
RegistryType	string	The type of the image registry. Valid values: acr: ACR harbor: Harbor quay: Quay CI/CD: Jenkins.	harbor
Endpoints	string	The list of endpoints for the image service.	https://172.20.XXX.XXX/test
ImageId	string	The image ID.	f922bfeb6960436fe3f0e7b62fc6b9a0b47980986669c367c22433269404****
TagImmutable	integer	The tag immutability setting. If immutability is enabled, image versions other than latest cannot be used to overwrite existing versions in this repository. Valid values: 0: Mutable. 1: Immutable.	0
Statistics	string	The statistics of security events.	{ "baselineNum": 0, "newSuspicious": 0, "vul": 0 }
ImageAccessType	string	The registration status of the image repository. Valid values: IN_SAS: The repository is registered in Security Center. NOT_IN_SAS: The repository is not registered in Security Center.	IN_SAS
Image	string	The image.	.aliyuncs.com/sas_test/baseline:exploit
Uuid	string	The unique identifier of the image.	624778f3-5bf2-423c-ac0c-47a62c05****
EndPointList	array<object>	The list of endpoint information.
	object	The endpoint information.
Domains	array	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
Type	string	The type of the domain name in the endpoint. Valid values: internet: Internet intranet: internal network	internet
InternetURLs	string	The public network access URL of the image repository.	**registry-registry.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-**
VpcURLs	string	The VPC access URL of the image repository.	**-registry-registry-vpc.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-**
PageInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	23
Count	integer	The number of entries returned on the current page in a paging query.	3
PageSize	integer	The maximum number of entries per page in a paging query.	20
CurrentPage	integer	The page number of the current page in a paging query.	1

Examples

Success response

JSON format

{
  "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 status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.