Query image information using DescribeImageInstances - Security Center

Retrieves information about 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:DescribeImageInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Criteria	string	No	The search condition that is used to filter the server. The value of this parameter is in the JSON format and contains the following fields: name: the search condition name: the value of the search condition logicalExp: the logical relation for multiple search conditions Valid values: OR: The search conditions use a logical OR. AND: The search conditions use a logical AND. Note You can call the DescribeImageCriteria operation to query the supported search conditions.	[{"name":"instanceId","value":"390100182","logicalExp":"AND"}]
LogicalExp	string	No	The logical relationship that you want to use to evaluate multiple search conditions. Valid values: OR: The search conditions are evaluated by using a logical OR. AND: The search conditions are evaluated by using a logical AND.	OR
PageSize	integer	No	The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note : We recommend that you do not leave this parameter empty.	20
CurrentPage	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
Scanned	boolean	No	Specifies whether the image is scanned. Valid values: true false	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	BE120DAB-F4E7-4C53-ADC3-A97578ABF384
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of returned entries.	69
Count	integer	The number of images returned on the current page.	4
ImageInstanceList	array<object>	The information about the images.
	object	The information about the image.
Status	string	The status of the image. Valid values: NORMAL	NORMAL
Digest	string	The digest value of the image.	a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****
RegistryType	string	The type of the image. Valid values: acr harbor quay CI/CD	acr
Tag	string	The tag of the image.	mysql_5.7
ImageUpdate	string	The timestamp generated when the image was updated. Unit: milliseconds.	1600069948849
RepoType	string	The type of the repository. Valid values: private public	private
ImageSize	string	The size of the image. Unit: MB.	1604487690
HcStatus	string	Indicates whether baseline risks exist. Valid values: NO YES	NO
VulCount	integer	The number of vulnerabilities in the image.	0
ImageId	string	The ID of the image.	c20987f18b130f9d144c9828df630417e2a9523148930dc3963e9d0dab30****
Endpoints	string	The address of the image.	[]
RiskStatus	string	Indicates whether risks exist. Valid values: NO YES	NO
ImageCreate	string	The timestamp generated when the image was created. Unit: milliseconds.	1600069948849
VulStatus	string	Indicates whether vulnerabilities exist in the image. Valid values: YES NO	NO
AlarmStatus	string	Indicates whether alerts are generated for the image. Valid values: YES NO	NO
ScaProgress	integer	The scan progress of the image. Valid values: 0 to 100.	100
InstanceId	string	The instance ID of the image.	39010****
RegionId	string	The region ID of the image.	cn-hangzhou
ScaStatus	string	The scan status of the image. Valid values: INIT: The image scan task is pending startup. START: The image scan task is started. MESSAGE_SEND: The message about the image scan task is sent. START_RUN: The image analysis task is started. DOWNLOAD: The image scan result is downloaded. PRE_ANALYZER: The image pre-analysis is started. WEB_SHELL_ANALYZER: The WebShell analysis of the image is complete. CVE_ANALYZER: The Common Vulnerabilities and Exposures (CVE) analysis of the image is complete. BIN_ANALYZER: The binary analysis of the image is complete. OTHER_ANALYZER: The extended analysis of the image is complete. SUCCESS: The image scan task is complete. PRE_ANALYZER_SUCCESS: The image pre-analysis is complete. FAIL: The image scan task failed. TIMEOUT: The image scan task timed out.	SUCCESS
Uuid	string	The UUID of the server.	12f80307-60aa-4efa-863a-56d72fb****
RepoId	string	The ID of the image repository.	f2b86d20bf0855af6aa268ce90fd****
HcCount	integer	The number of baseline risks.	0
ScaResult	string	The error code of the image scan result. Valid values: TASK_NOT_EXISTS: The image scan task does not exist. TASK_NOT_SUPPORT_REGION: The image scan task cannot be performed in the current region. forbid_create_repeat_task: The image scan task already exists.	TASK_NOT_SUPPORT_REGION
RepoName	string	The name of the image repository.	sas-script-test
AlarmCount	integer	The number of alerts that are generated for the image.	0
RepoNamespace	string	The namespace to which the image repository belongs.	N/A
Deployed	integer	Indicates whether the image was deployed. Valid values: 0: The image was not deployed. 1: The image was deployed.	1
LastScanTime	integer	The timestamp when the last scan was performed. Unit: milliseconds.	1721363159000
SourceBizTag	string	The usage label of the image.	PAI

Examples

Success response

JSON format

{
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578ABF384",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69,
    "Count": 4
  },
  "ImageInstanceList": [
    {
      "Status": "NORMAL",
      "Digest": "a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****",
      "RegistryType": "acr",
      "Tag": "mysql_5.7",
      "ImageUpdate": "1600069948849",
      "RepoType": "private",
      "ImageSize": "1604487690",
      "HcStatus": "NO",
      "VulCount": 0,
      "ImageId": "c20987f18b130f9d144c9828df630417e2a9523148930dc3963e9d0dab30****",
      "Endpoints": "[]",
      "RiskStatus": "NO",
      "ImageCreate": "1600069948849",
      "VulStatus": "NO",
      "AlarmStatus": "NO",
      "ScaProgress": 100,
      "InstanceId": "39010****",
      "RegionId": "cn-hangzhou",
      "ScaStatus": "SUCCESS",
      "Uuid": "12f80307-60aa-4efa-863a-56d72fb****",
      "RepoId": "f2b86d20bf0855af6aa268ce90fd****",
      "HcCount": 0,
      "ScaResult": "TASK_NOT_SUPPORT_REGION",
      "RepoName": "sas-script-test",
      "AlarmCount": 0,
      "RepoNamespace": "N/A",
      "Deployed": 1,
      "LastScanTime": 1721363159000,
      "SourceBizTag": "PAI"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.