All Products
Search
Document Center

Security Center:CreateContainerScanTaskByAppName

Last Updated:Nov 14, 2024

Creates a scan task for a running container application based on the application name.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:CreateContainerScanTaskByAppNamecreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringNo

The cluster ID.

cfb7a55a81f7246b5ac18845ea79a****
AppNamesstringNo

The name of the container application.

app-centos-01
LangstringNo

The language of the content within the request and response.

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

PlainResult

Dataobject

The data returned if the request was successful.

TaskIdstring

The ID of the scan task.

fc98d58eb56f699d49bf7ebbd6d7****
TotalCountinteger

The total number of container applications that you want to scan.

5
FinishCountinteger

The number of container applications that are scanned.

5
CollectTimelong

The timestamp generated when the image information was collected. Unit: milliseconds.

1644286364150
ExecTimelong

The timestamp generated when the scan task started. Unit: milliseconds.

1644286364150
Statusstring

The status of the scan task. Valid values:

  • INIT: The task is being initialized.
  • PRE_ANALYZER: The task is being pre-processed.
  • SUCCESS: The task succeeds.
  • FAIL: The task fails.
SUCCESS
Progressinteger

The progress of the scan task in percentage.

100
Resultstring

The result of the scan task. Valid values:

  • SUCCESS: The task is successful.
  • TASK_NOT_SUPPORT_REGION: The task is not supported in the region where the image is deployed.
Note
SUCCESS
CanCreateboolean

Indicates whether you can create more scan tasks. Valid values:

  • true
  • false
true
RequestIdstring

The request ID.

1EE7B150-D67E-53FD-A52D-3E8E669A****
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "TaskId": "fc98d58eb56f699d49bf7ebbd6d7****",
    "TotalCount": 5,
    "FinishCount": 5,
    "CollectTime": 1644286364150,
    "ExecTime": 1644286364150,
    "Status": "SUCCESS",
    "Progress": 100,
    "Result": "SUCCESS",
    "CanCreate": true
  },
  "RequestId": "1EE7B150-D67E-53FD-A52D-3E8E669A****",
  "HttpStatusCode": 200
}

Error codes

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

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

Change history

Change timeSummary of changesOperation
2024-09-27The Error code has changedView Change Details
2024-07-25The Error code has changedView Change Details
2023-10-07The Error code has changedView Change Details