查询映射列表 - ShowMapperList
功能介绍
查询映射列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/mappers/search
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间ID 取值范围: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
mapping_id |
是 |
String |
映射id |
|
workspace_id |
否 |
String |
映射id |
|
project_id |
否 |
String |
映射id |
|
dataclass_id |
否 |
String |
映射id |
|
datasource_instance_id |
否 |
String |
映射id |
|
status |
否 |
String |
状态(enabled,disabled) |
|
name |
否 |
String |
名称 |
|
has_preprocess_rule |
否 |
Boolean |
是否配置预处理规则 |
|
start_time |
否 |
String |
开始时间 |
|
end_time |
否 |
String |
结束时间 |
|
offset |
否 |
Integer |
参数解释: 偏移量 约束限制: 0-10000 取值范围: 不涉及 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 当前页码 约束限制: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
|
size |
Integer |
分页查询数据大小 |
|
page |
Integer |
当前页码 |
|
total |
Integer |
总数 |
|
data |
Array of DpeMappingContent objects |
分类映射信息集合 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
映射id |
|
name |
String |
名称 |
|
project_id |
String |
映射id |
|
workspace_id |
String |
映射id |
|
dataclass_id |
String |
映射id |
|
dataclass_name |
String |
数据类名称 |
|
mapper_type_id |
String |
映射id |
|
mapping_id |
String |
映射id |
|
create_time |
String |
创建时间 |
|
creator_id |
String |
创建者id |
|
creator_name |
String |
创建者名称 |
|
update_time |
String |
更新时间 |
|
modifier_id |
String |
修改者id |
|
modifier_name |
String |
修改者名称 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
查询映射列表示例
{
"mapping_id" : "6322b307-5a82-3287-a975-03b620408987",
"offset" : 0,
"limit" : 5
}
响应示例
状态码:200
查询映射列表响应
{
"code" : "00000000",
"data" : [ {
"create_time" : "2026-01-07T18:12:34.000Z+0800",
"creator_id" : "system",
"creator_name" : "system",
"dataclass_id" : "870692ea-a6b3-3fdd-afc1-84f97aa6b078",
"dataclass_name" : "Alert",
"id" : "00e83bf8-8201-3409-8f6b-64914b2ea2c4",
"mapper_type_id" : "9039fdc3c6ec70b2de9892baa249cd5c",
"mapping_id" : "6322b307-5a82-3287-a975-03b620408987",
"modifier_id" : "",
"modifier_name" : "",
"name" : "Redis Vulnerability Exploit",
"project_id" : "15645222e8744afa985c93dab6341da6",
"update_time" : "2026-01-07T18:12:34.000Z+0800",
"workspace_id" : "57b5073d-9026-423f-96c3-2f427e5c008f"
}, {
"create_time" : "2026-01-07T18:12:34.000Z+0800",
"creator_id" : "system",
"creator_name" : "system",
"dataclass_id" : "870692ea-a6b3-3fdd-afc1-84f97aa6b078",
"dataclass_name" : "Alert",
"id" : "0388cdef-df19-326b-aad7-dc487280ce35",
"mapper_type_id" : "9e02d574bccbbdffb7d0bd8601af8e11",
"mapping_id" : "6322b307-5a82-3287-a975-03b620408987",
"modifier_id" : "",
"modifier_name" : "",
"name" : "Abnormal External Behavior",
"project_id" : "15645222e8744afa985c93dab6341da6",
"update_time" : "2026-01-07T18:12:34.000Z+0800",
"workspace_id" : "57b5073d-9026-423f-96c3-2f427e5c008f"
}, {
"create_time" : "2026-01-07T18:12:34.000Z+0800",
"creator_id" : "system",
"creator_name" : "system",
"dataclass_id" : "870692ea-a6b3-3fdd-afc1-84f97aa6b078",
"dataclass_name" : "Alert",
"id" : "044bbf04-1d15-3729-a2d7-1d60320217d3",
"mapper_type_id" : "5ff338de709f487e0543bc89c92b1af5",
"mapping_id" : "6322b307-5a82-3287-a975-03b620408987",
"modifier_id" : "",
"modifier_name" : "",
"name" : "Process Injection",
"project_id" : "15645222e8744afa985c93dab6341da6",
"update_time" : "2026-01-07T18:12:34.000Z+0800",
"workspace_id" : "57b5073d-9026-423f-96c3-2f427e5c008f"
}, {
"create_time" : "2026-01-07T18:12:34.000Z+0800",
"creator_id" : "system",
"creator_name" : "system",
"dataclass_id" : "870692ea-a6b3-3fdd-afc1-84f97aa6b078",
"dataclass_name" : "Alert",
"id" : "0cecf3bd-d901-3d08-ba94-6e69bfd035fa",
"mapper_type_id" : "4d9de9c399e5198b8f12d93f6f9855ae",
"mapping_id" : "6322b307-5a82-3287-a975-03b620408987",
"modifier_id" : "",
"modifier_name" : "",
"name" : "Command Execution",
"project_id" : "15645222e8744afa985c93dab6341da6",
"update_time" : "2026-01-07T18:12:34.000Z+0800",
"workspace_id" : "57b5073d-9026-423f-96c3-2f427e5c008f"
}, {
"create_time" : "2026-01-07T18:12:34.000Z+0800",
"creator_id" : "system",
"creator_name" : "system",
"dataclass_id" : "870692ea-a6b3-3fdd-afc1-84f97aa6b078",
"dataclass_name" : "Alert",
"id" : "10cec3e2-e251-3eba-a40b-e1e7993a13a7",
"mapper_type_id" : "8561b4944811316c832a47cf7fee3520",
"mapping_id" : "6322b307-5a82-3287-a975-03b620408987",
"modifier_id" : "",
"modifier_name" : "",
"name" : "Remote Code Execution",
"project_id" : "15645222e8744afa985c93dab6341da6",
"update_time" : "2026-01-07T18:12:34.000Z+0800",
"workspace_id" : "57b5073d-9026-423f-96c3-2f427e5c008f"
} ],
"message" : "",
"page" : 0,
"size" : 5,
"total" : 71
}
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 49 50 51 52 53 |
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.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class ShowMapperListSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); ShowMapperListRequest request = new ShowMapperListRequest(); request.withWorkspaceId("{workspace_id}"); QueryDpeMapperRequestBody body = new QueryDpeMapperRequestBody(); body.withLimit(5); body.withOffset(0); body.withMappingId("6322b307-5a82-3287-a975-03b620408987"); request.withBody(body); try { ShowMapperListResponse response = client.showMapperList(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 33 34 35 36 37 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowMapperListRequest() request.workspace_id = "{workspace_id}" request.body = QueryDpeMapperRequestBody( limit=5, offset=0, mapping_id="6322b307-5a82-3287-a975-03b620408987" ) response = client.show_mapper_list(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowMapperListRequest{} request.WorkspaceId = "{workspace_id}" limitQueryDpeMapperRequestBody:= int32(5) offsetQueryDpeMapperRequestBody:= int32(0) request.Body = &model.QueryDpeMapperRequestBody{ Limit: &limitQueryDpeMapperRequestBody, Offset: &offsetQueryDpeMapperRequestBody, MappingId: "6322b307-5a82-3287-a975-03b620408987", } response, err := client.ShowMapperList(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询映射列表响应 |
|
400 |
请求异常返回报文 |
错误码
请参见错误码。