All Products
Search
Document Center

Security Center:CreateContainerScanTaskByAppName

Last Updated:Feb 20, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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
2023-10-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500