# 获取任务列表 - ListJob #### 功能介绍 功能介绍：获取任务列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/sdg/scan/job 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 每页数量限制 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 10 | | offset | 否 | Integer | **参数解释：** 分页偏移 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 0 | | content | 否 | String | **参数解释：** 扫描内容 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | is_new | 否 | Boolean | **参数解释：** 是否新增 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 1 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Long | **参数解释：** 总记录数 **取值范围：** 不涉及 | | tasks | Array of [ScanJob] objects | **参数解释：** 任务列表 **取值范围：** 不涉及 | | asset_id | String | **参数解释：** 资产ID **取值范围：** 不涉及 | | asset_infos | Array of strings | **参数解释：** 资产信息 **取值范围：** 不涉及 | | asset_type | String | **参数解释：** 资产类型 **取值范围：** 不涉及 | | create_time | Long | **参数解释：** 创建时间 **取值范围：** 不涉及 | | cycle | String | **参数解释：** 周期 **取值范围：** 不涉及 | | id | String | **参数解释：** 唯一标识 **取值范围：** 不涉及 | | last_run_time | Long | **参数解释：** 最后运行时间 **取值范围：** 不涉及 | | last_scan_risk | String | **参数解释：** 最后扫描风险 **取值范围：** 不涉及 | | name | String | **参数解释：** 名称 **取值范围：** 不涉及 | | open | Boolean | **参数解释：** 是否开启 **取值范围：** true-是，false-否 | | progress | Integer | **参数解释：** 进度 **取值范围：** 不涉及 | | rule_groups | Array of strings | **参数解释：** 规则组列表 **取值范围：** 不涉及 | | scan_mode | String | **参数解释：** 扫描模式 **取值范围：** 不涉及 | | scan_sensitivity | String | **参数解释：** 扫描敏感度 **取值范围：** NULL-不涉及，LOW-低灵敏度，MIDDLE-中灵敏度，HIGH-高灵敏度 | | scan_templates | Object | **参数解释：** 扫描模板 **取值范围：** 不涉及 | | scan_time_scope | Integer | **参数解释：** 扫描时间范围 **取值范围：** 不涉及 | | security_level_color | Integer | **参数解释：** 安全级别名称 **取值范围：** 不涉及 | | security_level_name | String | **参数解释：** 安全级别名称 **取值范围：** 不涉及 | | start_time | Long | **参数解释：** 开始时间 **取值范围：** 不涉及 | | status | String | **参数解释：** 状态 **取值范围：** 不涉及 | | task_source | String | **参数解释：** 任务来源 **取值范围：** 不涉及 | | template_type | String | **参数解释：** 模板类型 **取值范围：** 不涉及 | | topic_urn | String | **参数解释：** 主题URN **取值范围：** 不涉及 | | use_nlp | Boolean | **参数解释：** 是否使用NLP **取值范围：** true-是，false-否 | | workspace_id | String | **参数解释：** 工作空间ID **取值范围：** 不涉及 | 表5ScanJob | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 资源ID，唯一标识 **取值范围：** 不涉及 | | name | String | **参数解释：** 扫描任务名称 **取值范围：** 不涉及 | | rule_groups | Array of strings | **参数解释：** 规则分组 **取值范围：** 不涉及 | | scan_templates | Map\ | **参数解释：** 扫描模板 **取值范围：** 不涉及 | | cycle | String | **参数解释：** 扫描周期 **取值范围：** 不涉及 | | status | String | **参数解释：** 操作结果状态 **取值范围：** - INIT-初始化 - WAITING-等待 - RUNNING-运行中 - FAILED-失败 - STOPPED-已停止 - FINISHED-已完成 - TERMINATED-已终止 - QUOTA_RESTRICTED-配额受限 - OBS_QUOTA_RESTRICTED-OBS配额受限 - DB_QUOTA_RESTRICTED-DB配额受限 - LOCKED-已锁定 | | last_run_time | Long | **参数解释：** 上次运行时间 **取值范围：** 不涉及 | | create_time | Long | **参数解释：** 创建时间 **取值范围：** 不涉及 | | last_scan_risk | String | **参数解释：** 上次扫描风险 **取值范围：** 不涉及 | | use_nlp | Boolean | **参数解释：** 已用自然语言处理 **取值范围：** true-是，false-否 | | open | Boolean | **参数解释：** 是否开启扫描 **取值范围：** true-是，false-否 | | topic_urn | String | **参数解释：** 主题URN **取值范围：** 不涉及 | | start_time | Long | **参数解释：** 开始时间 **取值范围：** 不涉及 | | task_source | String | **参数解释：** 开始时间 **取值范围：** 不涉及 | | workspace_id | String | **参数解释：** 资产ID **取值范围：** 不涉及 | | security_level_name | String | **参数解释：** 安全等级名称 **取值范围：** 不涉及 | | security_level_color | Integer | **参数解释：** 安全等级颜色 **取值范围：** 不涉及 | | asset_infos | Array of [AssetInfo] objects | **参数解释：** 资产信息列表 **取值范围：** 不涉及 | | scan_time_scope | Integer | **参数解释：** 扫描时间范围 **取值范围：** 不涉及 | | scan_sensitivity | String | **参数解释：** 扫描敏感度 **取值范围：** - NULL-空 - LOW-低 - MIDDLE-中 - HIGH-高 | | template_type | String | **参数解释：** 扫描作业类型 **取值范围：** 不涉及 | | scan_mode | String | **参数解释：** 扫描作业模式 **取值范围：** 不涉及 | | progress | Integer | **参数解释：** 扫描进度 **取值范围：** 不涉及 | | asset_id | String | **参数解释：** 资产ID **取值范围：** 不涉及 | | asset_type | String | **参数解释：** 扫描作业类型 **取值范围：** 不涉及 | 表6AssetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 资产信息 **取值范围：** 不涉及 | #### 请求示例 获取任务列表 ``` /v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/scan/job ``` #### 响应示例 **状态码：200** ``` { "total" : 2, "tasks" : [ { "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c", "name" : "scan-job-01", "rule_groups" : [ "scan-job-01" ], "scan_templates" : { "scan-template-01" : "scan-job-01" }, "cycle" : "DAY", "status" : "FINISHED", "last_run_time" : 1700000000000, "create_time" : 1700000000000, "last_scan_risk" : "scan-job-01", "use_nlp" : true, "open" : true, "topic_urn" : "urn:smn:cn-north-4:826314dd1b5b4037b9765f9b7a17df46:classification-notice", "start_time" : 1700000000000, "task_source" : "scan-job-01", "workspace_id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c", "security_level_name" : "scan-job-01", "security_level_color" : 3, "asset_infos" : [ { "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" }, { "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" } ], "scan_time_scope" : 1700000000000, "scan_sensitivity" : "HIGH", "template_type" : "BUILT_IN", "scan_mode" : "AUTO", "progress" : 100, "asset_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f", "asset_type" : "OBS" }, { "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c", "name" : "scan-job-01", "rule_groups" : [ "scan-job-01" ], "scan_templates" : { "scan-template-01" : "scan-job-01" }, "cycle" : "DAY", "status" : "FINISHED", "last_run_time" : 1700000000000, "create_time" : 1700000000000, "last_scan_risk" : "scan-job-01", "use_nlp" : true, "open" : true, "topic_urn" : "urn:smn:cn-north-4:826314dd1b5b4037b9765f9b7a17df46:classification-notice", "start_time" : 1700000000000, "task_source" : "scan-job-01", "workspace_id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c", "security_level_name" : "scan-job-01", "security_level_color" : 3, "asset_infos" : [ { "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" }, { "id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c" } ], "scan_time_scope" : 1700000000000, "scan_sensitivity" : "HIGH", "template_type" : "BUILT_IN", "scan_mode" : "AUTO", "progress" : 100, "asset_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f", "asset_type" : "OBS" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。