Updated on 2022-12-29 GMT+08:00

Querying the Identification Task List

Function

This API is used to query the identification task list.

URI

GET /v1/{project_id}/sdg/scan/jobs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Page number

limit

No

Integer

Page size

content

No

String

Content

start_time

No

String

This parameter is currently unavailable.

end_time

No

String

This parameter is currently unavailable.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tasks

Array of ScanJob objects

List of identification tasks

total

Long

Total number of tasks

Table 4 ScanJob

Parameter

Type

Description

id

String

Task ID

name

String

Task name

rule_groups

Array of strings

Rule group used by a task

cycle

String

Task execution type

Enumeration values:

  • ONCE

  • DAY

  • WEEK

  • MONTH

status

String

Task status

Enumeration values:

  • INIT

  • WAITING

  • RUNNING

  • FAILED

  • STOPPED

  • FINISHED

  • TERMINATED

last_run_time

Long

Last execution time

create_time

Long

Task creation time

last_scan_risk

String

Risk level according to the last identification

use_nlp

Boolean

Whether NLP is used for identification

open

Boolean

Whether the task is started

topic_urn

String

SMN topic

start_time

Long

Task start time

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Querying the Identification Task List

GET /v1/{project_id}/sdg/scan/jobs

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "tasks" : [ {
    "id" : "xxxxxxx",
    "name" : "ScanDemo",
    "cycle" : "ONCE",
    "status" : "FINISHED",
    "open" : true,
    "rule_groups" : [ "PCI" ],
    "last_run_time" : 1634612489173,
    "create_time" : 1630982438506,
    "last_scan_risk" : "HIGH",
    "use_nlp" : false,
    "topic_urn" : "",
    "start_time" : 1630983532673
  } ]
}

Status code: 400

Invalid request

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

OK

400

Invalid request

Error Codes

See Error Codes.