获取指定作业下的扫描结果 - ShowScanJobResults
功能介绍
功能介绍:获取指定作业下的扫描结果,支持分页和类型过滤。 关键参数说明:通过job_id定位作业;支持limit/offset分页(默认100/0)、type结果类型、start_time/end_time时间范围过滤。 返回值说明:返回数据库/OBS/ES扫描结果明细。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/scan/job/{job_id}/results
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 扫描作业ID,标识需要获取扫描结果的扫描作业,可通过创建扫描作业接口获取,或通过查询扫描作业列表接口获取 约束限制: 不涉及 取值范围: 长度1~64个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页数量限制 约束限制: 不涉及 取值范围: 不涉及 默认取值: 100 |
| offset | 否 | Integer | 参数解释: 分页偏移 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| type | 否 | String | 参数解释: 结果类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: DATABASE |
| start_time | 否 | String | 参数解释: 开始时间,查询扫描结果的时间范围起始点,格式为yyyy-MM-ddTHH:mm:ssZ,例如2023-01-01T00:00:00Z 约束限制: 不涉及 取值范围: 字符串类型,为ISO8601时间格式 默认取值: 不涉及 |
| end_time | 否 | String | 参数解释: 结束时间,查询扫描结果的时间范围结束点,格式为yyyy-MM-ddTHH:mm:ssZ,例如2023-01-01T00:00:00Z 约束限制: 不涉及 取值范围: 字符串类型,为ISO8601时间格式 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释: 扫描结果响应ID 取值范围: 不涉及 |
| job_name | String | 参数解释: 扫描结果响应名称 取值范围: 不涉及 |
| type | String | 参数解释: 结果类型 取值范围: 不涉及 |
| asset_infos | Array of AssetInfo objects | 参数解释: 资产信息列表 取值范围: 不涉及 |
| db_scan_result | DbScanResult object | 参数解释: 数据库扫描结果 取值范围: 不涉及 |
| obs_scan_result | ObsScanResult object | 参数解释: OBS扫描结果 取值范围: 不涉及 |
| es_scan_result | EsScanResult object | 参数解释: ES扫描结果 取值范围: 不涉及 |
| asset_id | String | 参数解释: 资产ID 取值范围: 不涉及 |
| asset_type | String | 参数解释: 资产类型 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| asset_id | String | 参数解释: 资产ID,标识扫描资产的唯一标识 取值范围: 字符串类型 |
| asset_type | String | 参数解释: 资产类型,标识扫描资产的类型 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| db_scan_results | Array of DbScanResultInfo objects | 参数解释: 数据库扫描结果 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID 取值范围: 不涉及 |
| db_name | String | 参数解释: 数据库名称 取值范围: 不涉及 |
| table_id | String | 参数解释: 数据库扫描结果信息ID 取值范围: 不涉及 |
| table_name | String | 参数解释: 数据库扫描结果信息名称 取值范围: 不涉及 |
| risk_level | Integer | 参数解释: 数据库扫描结果信息等级 取值范围: 不涉及 |
| sensitive_data_type | Array of strings | 参数解释: 敏感数据类型 取值范围: 不涉及 |
| match_info | Array of DbMatchInfo objects | 参数解释: 匹配信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| column_name | String | 参数解释: 数据库列名,标识匹配到敏感数据的数据库列名称 取值范围: 字符串类型 |
| rule_name | String | 参数解释: 规则名称 取值范围: 不涉及 |
| rule_id | String | 参数解释: 规则ID 取值范围: 不涉及 |
| rule_risk_level | Integer | 参数解释: 规则风险级别 取值范围: 不涉及 |
| column_line | Array of longs | 参数解释: 列中匹配到敏感数据的行号集合,列表元素为数值类型的行号 取值范围: 数组类型 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| obs_scan_results | Array of ObsScanResultInfo objects | 参数解释: OBS扫描结果 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID 取值范围: 不涉及 |
| bucket_id | String | 参数解释: 桶ID 取值范围: 不涉及 |
| bucket_name | String | 参数解释: 桶名称 取值范围: 不涉及 |
| file_path | String | 参数解释: 文件路径 取值范围: 不涉及 |
| file_name | String | 参数解释: 文件名称 取值范围: 不涉及 |
| md5 | String | 参数解释: MD5校验值 取值范围: 不涉及 |
| risk_level | Integer | 参数解释: 风险级别 取值范围: 不涉及 |
| sensitive_data_type | Array of strings | 参数解释: 敏感数据类型 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| es_scan_results | Array of EsScanResultInfo objects | 参数解释: ES扫描结果 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID 取值范围: 不涉及 |
| index_name | String | 参数解释: 索引名称 取值范围: 不涉及 |
| type_id | String | 参数解释: 类型ID 取值范围: 不涉及 |
| type_name | String | 参数解释: 类型名称 取值范围: 不涉及 |
| risk_level | Integer | 参数解释: 风险级别 取值范围: 不涉及 |
| sensitive_data_type | Array of strings | 参数解释: 敏感数据类型 取值范围: 不涉及 |
| match_info | Array of EsMatchInfo objects | 参数解释: 匹配信息 取值范围: 不涉及 |
请求示例
获取指定作业下的扫描结果
/v1/2b31ed520aabbccddeedb6e571234567/sdg/scan/job/3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d/results
响应示例
状态码:200
{
"job_id" : "3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d",
"job_name" : "scan-job-01",
"type" : "OBS",
"asset_infos" : [ {
"asset_id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"asset_type" : "OBS"
} ],
"db_scan_result" : {
"total" : 1,
"db_scan_results" : [ {
"task_id" : "6d0e1f2a-3b4c-4d5e-0f1a-9b8c7d6e5f4a",
"db_name" : "database-01",
"table_id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c",
"table_name" : "user_info_table",
"risk_level" : 3,
"sensitive_data_type" : [ "OBS" ],
"match_info" : [ {
"column_name" : "phone_number",
"rule_name" : "classification-rule-01",
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"rule_risk_level" : 3,
"column_line" : [ 1, 2, 2 ]
} ]
} ]
}
} SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dsc.v1.region.DscRegion; import com.huaweicloud.sdk.dsc.v1.*; import com.huaweicloud.sdk.dsc.v1.model.*; public class ShowScanJobResultsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); ShowScanJobResultsRequest request = new ShowScanJobResultsRequest(); request.withJobId("{job_id}"); try { ShowScanJobResultsResponse response = client.showScanJobResults(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdsc.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowScanJobResultsRequest() request.job_id = "{job_id}" response = client.show_scan_job_results(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dsc.NewDscClient(hcClient) request := &model.ShowScanJobResultsRequest{} request.JobId = "{job_id}" response, err := client.ShowScanJobResults(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。