GetRepoTagScanStatus-阿里云帮助中心

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

cr:GetScan

get

*Repository

acs:cr:{#regionId}:{#accountId}:repository/{#instanceid}/{#namespacename}/{#repositoryname}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	cri-2j88dtld8yel****
RepoId	string	No	The ID of the repository.	crr-uf082u9dg8do****
Tag	string	No	The image tag.	1
ScanTaskId	string	No	The ID of the image scan task.	838152F9-F725-5A52-A344-8972D65AC045
Digest	string	No	The image digest.	67bfbcc12b67936ec7f867927817cbb071832b873dbcaed312a1930ba5f1d529
ScanType	string	No

Response elements

Element	Type	Description	Example
	object
Status	string	The scan status of the image. Valid values: `SCANNING`: The image is being scanned. `COMPLETE`: The scan is complete. `FAILED`: The scan failed. `RETRYING`: The scan is being retried.	COMPLETE
Code	string	The return code.	success
IsSuccess	boolean	Specifies whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
RequestId	string	The request ID.	BC648259-91A7-4502-BED3-EDF64361FA83
ScanService	string	The scan engine type. Valid values: `ACR_SCAN_SERVICE`: the ACR Trivy scan engine. `SAS_SCAN_SERVICE`: the Cloud Security scan engine.	ACR_SCAN_SERVICE

Examples

Success response

JSON format

{
  "Status": "COMPLETE",
  "Code": "success",
  "IsSuccess": true,
  "RequestId": "BC648259-91A7-4502-BED3-EDF64361FA83",
  "ScanService": "ACR_SCAN_SERVICE"
}

Error codes

HTTP status code	Error code	Error message	Description
500	SystemError	Unknown error.
403	NoPrivilege	Access denied for this user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.