Querying Classifications & Mappings
Function
This API is used to query the list of classifications & mappings.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/search
|
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
|
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. Constraints N/A Range Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
status |
No |
String |
Status. |
|
name |
No |
String |
Name. |
|
start_time |
No |
String |
Start time. |
|
end_time |
No |
String |
End time. |
|
offset |
Yes |
Integer |
Definition Offset. Constraints 0-10000 Range N/A Default Value 0 |
|
limit |
Yes |
Integer |
Definition Current page number. Constraints N/A |
Response Parameters
Status code: 200
|
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 DpeInfo objects |
Categorical mapping set. |
|
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. |
|
classifier_id |
String |
Associated classification ID. |
|
status |
String |
Status. |
|
complete_degree |
String |
Progress. |
|
instance_num |
String |
The number of associated instances. |
|
built_in |
String |
Whether the data is built-in. |
|
data_source |
String |
Data source. |
|
description |
String |
Description. |
|
update_time |
String |
Update time. |
|
create_time |
String |
Creation time. |
|
creator_id |
String |
Creator ID. |
|
creator_name |
String |
Creator name. |
|
modifier_id |
String |
Modifier ID. |
|
modifier_name |
String |
Modifier name. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
This API is used to query the list of classifications & mappings.
{
"limit" : 10,
"offset" : 0
}
Example Responses
Status code: 200
Returned object of the classification and mapping list.
{
"code" : "00000000",
"data" : [ {
"built_in" : "true",
"classifier_id" : "a28f1965-6d85-31a4-8897-65483c80b986",
"complete_degree" : "111",
"create_time" : "2026-01-16T21:28:29.000Z+0800",
"creator_id" : "system",
"creator_name" : "system",
"data_source" : "MTD",
"dataclass_id" : "74ffa242-b515-36d4-8447-f06795a5c511",
"dataclass_name" : "Alert",
"description" : "mapping_info_1",
"id" : "1338f4e6-4e73-3231-ada8-3cebd8ff1771",
"instance_num" : "1",
"modifier_id" : "",
"modifier_name" : "",
"name" : "mapping_info_1",
"project_id" : "81fee81ab75a48a7b38e6586868688e7",
"status" : "ENABLED",
"update_time" : "2026-01-16T21:28:29.000Z+0800",
"workspace_id" : "79ad711e-ef72-4a5b-8b41-7f519023bb4d"
}, {
"built_in" : "true",
"classifier_id" : "dfdf9e03-193a-3293-8259-67f171ba54de",
"complete_degree" : "111",
"create_time" : "2026-01-16T21:28:29.000Z+0800",
"creator_id" : "system",
"creator_name" : "system",
"data_source" : "SECMASTER_BASELINE",
"dataclass_id" : "060eec0a-9ddf-31e0-9836-96cffae22ca8",
"dataclass_name" : "Baseline",
"description" : "mapping_info_2",
"id" : "1fb75689-7246-30cb-a000-73496c4d37ba",
"instance_num" : "1",
"modifier_id" : "",
"modifier_name" : "",
"name" : "mapping_info_2",
"project_id" : "81fee81ab75a48a7b38e6586868688e7",
"status" : "ENABLED",
"update_time" : "2026-01-16T21:28:29.000Z+0800",
"workspace_id" : "79ad711e-ef72-4a5b-8b41-7f519023bb4d"
} ],
"message" : "",
"page" : 0,
"size" : 2,
"total" : 2
}
SDK Sample Code
The SDK sample code is as follows.
This API is used to query the list of classifications & mappings.
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 |
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 ShowMappingInfoListSolution { 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(); ShowMappingInfoListRequest request = new ShowMappingInfoListRequest(); request.withWorkspaceId("{workspace_id}"); QueryDpeRequestBody body = new QueryDpeRequestBody(); body.withLimit(10); body.withOffset(0); request.withBody(body); try { ShowMappingInfoListResponse response = client.showMappingInfoList(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()); } } } |
This API is used to query the list of classifications & mappings.
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 |
# 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 = ShowMappingInfoListRequest() request.workspace_id = "{workspace_id}" request.body = QueryDpeRequestBody( limit=10, offset=0 ) response = client.show_mapping_info_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) |
This API is used to query the list of classifications & mappings.
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 |
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.ShowMappingInfoListRequest{} request.WorkspaceId = "{workspace_id}" request.Body = &model.QueryDpeRequestBody{ Limit: int32(10), Offset: int32(0), } response, err := client.ShowMappingInfoList(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 |
Returned object of the classification and mapping list. |
|
400 |
Returned packet for abnormal requests. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot