Updated on 2026-02-05 GMT+08:00

Querying the Mapping List

Function

This API is used to query the mapping list.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/mappers/search

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Range

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

mapping_id

Yes

String

Mapping ID.

workspace_id

No

String

Mapping ID.

project_id

No

String

Mapping ID.

dataclass_id

No

String

Mapping ID.

datasource_instance_id

No

String

Mapping ID.

status

No

String

Status: enabled or disabled.

name

No

String

Name.

has_preprocess_rule

No

Boolean

Whether to configure a preprocessing rule.

start_time

No

String

Start time.

end_time

No

String

End time.

offset

No

Integer

Definition

Offset.

Constraints

0-10000

Range

N/A

Default Value

0

limit

No

Integer

Definition

Current page number.

Constraints

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

size

Integer

Page size for pagination query.

page

Integer

Current page number.

total

Integer

Total number.

data

Array of DpeMappingContent objects

Categorical mapping set.

Table 5 DpeMappingContent

Parameter

Type

Description

id

String

Mapping ID.

name

String

Name.

project_id

String

Mapping ID.

workspace_id

String

Mapping ID.

dataclass_id

String

Mapping ID.

dataclass_name

String

Data class name.

mapper_type_id

String

Mapping ID.

mapping_id

String

Mapping ID.

create_time

String

Creation time.

creator_id

String

Creator ID.

creator_name

String

Creator name.

update_time

String

Update time.

modifier_id

String

Modifier ID.

modifier_name

String

Modifier name.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

Query a mapping list.

{
  "mapping_id" : "6322b307-5a82-3287-a975-03b620408987",
  "offset" : 0,
  "limit" : 5
}

Example Responses

Status code: 200

Response to the request for querying the mapping list.

{
  "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 Sample Code

The SDK sample code is as follows.

Query a mapping list.

 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());
        }
    }
}

Query a mapping list.

 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)

Query a mapping list.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Response to the request for querying the mapping list.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.