PublicSyncAndCreateImageScanTask - Security Center - Alibaba Cloud Documentation Center

Adds images to Security Center and creates an image scan task to scan the images.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:PublicSyncAndCreateImageScanTask	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	1.2.X.X
Images	string	Yes	The information about the images. The value of this parameter is in the JSON format and contains the following fields: RegistryType: the type of the image repository. Valid values: acr harbor quay RepoId: the ID of the image repository. InstanceId: the ID of the Container Registry instance to which the image repository belongs. RepoNamespace: the namespace to which the image repository belongs. RegionId: the region ID of the image. RepoName: the name of the image repository. Digest: the digest of the image. Tag: the tag that is added to the image. CreateTime: the timestamp when the image was created. Unit: milliseconds. UpdateTime: the timestamp when the image was updated. Unit: milliseconds.	[{"registryType":"acr","repoId":"crr-red9kgqqi0fh75d5","instanceId":"cri-1x2qtjd75ofqvfa8","repoNamespace":"1125","regionId":"cn-hangzhou","repoName":"script1","digest":"b1064a5007786b6f82a50772858e8156bc1e5fbddb7dd20af6922761ad197fe4","tag":"v0113-ver2","createTime":1641267666666,"updateTime":1641267909090}]

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	F9353221-40F4-5F98-B73C-2803DC804033
Data	object	The data returned if the call is successful.
TaskId	string	The ID of the image scan task.	a410bb3e68c217a3368bc0238c66886d
TotalCount	integer	The total number of images to scan.	5
FinishCount	integer	The number of images that have been scanned.	5
CollectTime	long	The timestamp when the image information was collected. Unit: milliseconds.	1644286364150
ExecTime	long	The timestamp when the image scan task started to run. Unit: milliseconds.	1644286364150
Status	string	The status of the image scan task. Valid values: INIT: The task is being initialized. PRE_ANALYZER: The task is being pre-processed. SUCCESS: The task is successful. FAIL: The task failed.	SUCCESS
Progress	integer	The progress of the image scan task.	100
Result	string	The result of the image scan task. Valid values: SUCCESS: The task is successful. TASK_NOT_SUPPORT_REGION: The image is deployed in a region that is not supported by container image scan.	SUCCESS
CanCreate	boolean	Indicates whether you can create more image scan tasks. Valid values: true: yes false: no Note By default, a maximum of 10 image scan tasks can be running at the same time. If 10 image scan tasks are running, you cannot create an image scan task by calling this operation. You must wait for at least one of the 10 existing image scan tasks to complete before you can create an image scan task.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "F9353221-40F4-5F98-B73C-2803DC804033",
  "Data": {
    "TaskId": "a410bb3e68c217a3368bc0238c66886d",
    "TotalCount": 5,
    "FinishCount": 5,
    "CollectTime": 1644286364150,
    "ExecTime": 1644286364150,
    "Status": "SUCCESS",
    "Progress": 100,
    "Result": "SUCCESS",
    "CanCreate": true
  }
}

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-08-01	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-01-13	Add Operation	View Change Details