All Products
Search
Document Center

Security Center:DescribeOnceTaskLeafRecordPage

Last Updated:Nov 25, 2024

Queries the sub-task information of one-time scan task. A sub-task can be an image scan task or an image asset synchronization task.

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:DescribeOnceTaskLeafRecordPageget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerYes

The number of entries to return on each page. Default value: 20

20
CurrentPageintegerYes

The number of the page to return.

1
TaskTypestringYes

The type of the sub-task. Valid values:

  • IMAGE_SCAN: image scan task
  • IMAGE_REGISTRY_PULL: image asset synchronization task
CLIENT_PROBLEM_CHECK
RelateInfobooleanYes

Specifies whether extension information is associated.

true
TaskIdstringNo

The ID of the sub-task.

1471d8ebb96795b41ede090b9758****
SourcestringNo

The source of the request.

console_batch
StartTimelongNo

The start timestamp of the sub-task.

1648438617000
EndTimelongNo

The end timestamp of the sub-task.

1668064495000
StatusListarrayNo

The status information.

stringNo

The status of the sub-task. Valid values:

  • INIT: The sub-task is not started.
  • START: The sub-task is started.
  • SUCCESS: The sub-task is complete.
  • TIMEOUT: The sub-task timed out.
INIT

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

16
Countinteger

The number of entries returned on the current page.

6
OnceTasksarray<object>

The details of the sub-task.

OnceTasksobject

The information about the array object.

Statusstring

The status.

0
StatusTextstring

The sub-task status. Valid values:

  • INIT: The sub-task is not started.
  • START: The sub-task is started.
  • SUCCESS: The sub-task is complete.
  • TIMEOUT: The sub-task timed out.
SUCCESS
Progresslong

The progress percentage of the sub-task.

75
RealRunTimelong

The execution duration of the sub-task.

1670307567000
TaskNamestring

The name of the sub-task.

IMAGE_SCAN
Finishinteger

Indicates whether the sub-task is complete.

  • 0: no
  • 1: yes
1
TotalCountstring

The total number of entries returned.

30
EndTimelong

The time when the sub-task ends.

1670307567000
TaskTypestring

The type of the sub-task.

IMAGE_SCAN
StartTimelong

The time when the sub-task starts.

1640102400000
ResultInfostring

The execution result.

TASK_NOT_SUPPORT_REGION
Targetstring

The objective of the sub-task.

238cf050a7270dd6940602e70f1e5a11eeaf4e02035f445b7f613ff5e064****
TaskIdstring

The sub-task ID.

9fb50f2af8bb67c9fdb684194c83****
FinishCountstring

The number of the assets that are scanned.

67
TargetTypestring

The type of the assets that are scanned. Valid values:

  • IMAGE_REPO: image repository
  • IMAGE: image
IMAGE
TaskImageInfoobject

The information about the image scan.

RepoIdstring

The ID of the image repository.

crr-r88w2vryp8m****
Digeststring

The digest of the image.

9e0dc29d872d2e386cc5c0c92b529a84e3acfade16f5cb1d054a2ee3c99****
Tagstring

The tag that is added to the image.

v1.20-002-a2*****
RepoRegionIdstring

The region ID of the image repository.

cn-hangzhou
RepoNamestring

The name of the image repository.

testyyy
RepoNamespacestring

The name of the namespace to which the image repository belongs.

bitn***
RegionIdstring

The region ID of the server image.

cn-hangzhou
Imagestring

The image of the container.

***s.com/sas_test/baseli***
Podstring

The pod of the image.

expoit-law-****
AppNamestring

The name of the application.

ack-jenkins-****
NodeNamestring

The name of the node.

pztest****
NodeIpstring

The IP address of the node.

172.18.XXX.XXX
NodeInstanceIdstring

The instance ID of the node.

i-0xi5mxvtmfw9****
ClusterIdstring

The ID of the cluster.

a765ba1435e7f9446065370e9a41****
ClusterNamestring

The cluster name.

ACK-test-****
CostTimeInfostring

The time consumed. The value is in the JSON format. The end time of each item is displayed.

  • vul: system vulnerabilities
  • scaVul: application vulnerabilities
  • scaVul: baseline
  • binary: binary
  • forbiddenPackageInfo: information about the prohibited package
  • identificationInfo: identity authentication
  • script: malicious scripts
  • sensitiveFile: sensitive files
  • sensitiveInfo: AccessKey pair leaks
  • webshell: website scripts
{"scaVul":"2023-09-04 09:37:21","identificationInfo":"2023-09-04 09:37:30","forbiddenPackageInfo":"2023-09-04 09:37:16","binary":"2023-09-04 09:37:25","baseline":"2023-09-04 09:37:19","sensitiveFile":"2023-09-04 09:38:34","vul":"2023-09-04 09:37:31","webshell":"2023-09-04 09:38:27","sensitiveInfo":"2023-09-04 09:37:16","script":"2023-09-04 09:39:44"}

Examples

Sample success responses

JSONformat

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 16,
    "Count": 6
  },
  "OnceTasks": [
    {
      "Status": "0",
      "StatusText": "SUCCESS",
      "Progress": 75,
      "RealRunTime": 1670307567000,
      "TaskName": "IMAGE_SCAN",
      "Finish": 1,
      "TotalCount": "30",
      "EndTime": 1670307567000,
      "TaskType": "IMAGE_SCAN",
      "StartTime": 1640102400000,
      "ResultInfo": "TASK_NOT_SUPPORT_REGION",
      "Target": "238cf050a7270dd6940602e70f1e5a11eeaf4e02035f445b7f613ff5e064****",
      "TaskId": "9fb50f2af8bb67c9fdb684194c83****",
      "FinishCount": "67",
      "TargetType": "IMAGE",
      "TaskImageInfo": {
        "RepoId": "crr-r88w2vryp8m****",
        "Digest": "9e0dc29d872d2e386cc5c0c92b529a84e3acfade16f5cb1d054a2ee3c99****",
        "Tag": "v1.20-002-a2*****",
        "RepoRegionId": "cn-hangzhou",
        "RepoName": "testyyy",
        "RepoNamespace": "bitn***",
        "RegionId": "cn-hangzhou",
        "Image": "***s.com/sas_test/baseli***",
        "Pod": "expoit-law-****",
        "AppName": "ack-jenkins-****",
        "NodeName": "pztest****",
        "NodeIp": "172.18.XXX.XXX",
        "NodeInstanceId": "i-0xi5mxvtmfw9****",
        "ClusterId": "a765ba1435e7f9446065370e9a41****",
        "ClusterName": "ACK-test-****",
        "CostTimeInfo": "{\"scaVul\":\"2023-09-04 09:37:21\",\"identificationInfo\":\"2023-09-04 09:37:30\",\"forbiddenPackageInfo\":\"2023-09-04 09:37:16\",\"binary\":\"2023-09-04 09:37:25\",\"baseline\":\"2023-09-04 09:37:19\",\"sensitiveFile\":\"2023-09-04 09:38:34\",\"vul\":\"2023-09-04 09:37:31\",\"webshell\":\"2023-09-04 09:38:27\",\"sensitiveInfo\":\"2023-09-04 09:37:16\",\"script\":\"2023-09-04 09:39:44\"}"
      }
    }
  ]
}

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-09-07The response structure of the API has changedView Change Details