Updated on 2025-06-24 GMT+08:00

Querying the Indicator List

Function

This API is used to query the indicator list.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/indicators/search

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

content-type

Yes

String

application/json;charset=UTF-8

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ids

No

Array of strings

Threat indicator list.

dataclass_id

No

String

Data class ID.

condition

Yes

condition object

Search condition expression.

offset

Yes

Integer

request offset, from 0

limit

Yes

Integer

request limit size

sort_by

No

String

sort by property, create_time.

from_date

No

String

Query start time, for example, 2024-01-20T00:00:00.000Z+0800.

to_date

No

String

Query end time, for example, 2024-01-26T23:59:59.999Z+0800.

Table 4 condition

Parameter

Mandatory

Type

Description

conditions

No

Array of conditions objects

Expression list.

logics

No

Array of strings

Expression name list.

Table 5 conditions

Parameter

Mandatory

Type

Description

name

No

String

Expression name.

data

No

Array of strings

Expression content list.

Response Parameters

Status code: 200

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Table 7 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

total

Integer

Total number.

data

Array of IndicatorDetail objects

List of indicators.

Table 8 IndicatorDetail

Parameter

Type

Description

id

String

Threat indicator ID.

name

String

Threat indicator name.

data_object

IndicatorDataObjectDetail object

Indicator details.

workspace_id

String

Workspace ID.

project_id

String

Project ID.

dataclass_ref

DataClassRefPojo object

Data class object information.

create_time

String

Creation time.

update_time

String

Update time.

Table 9 IndicatorDataObjectDetail

Parameter

Type

Description

indicator_type

indicator_type object

Indicator type object.

value

String

Value, for example, ip, url, and domain.

update_time

String

Update time.

create_time

String

Creation time.

environment

environment object

Environment information.

data_source

data_source object

Data source information.

first_report_time

String

First occurrence time.

is_deleted

Boolean

Whether to delete.

last_report_time

String

Last occurrence time.

granular_marking

Integer

Granularity (confidentiality level). 1: First discovery; 2: Self-produced data; 3: Purchase required; and 4: Direct query from the external network.

name

String

Name.

id

String

Threat indicator ID.

project_id

String

Project ID.

revoked

Boolean

Whether to discard.

status

String

Status. The options are Open, Closed, and Revoked.

verdict

String

Threat degree. The options are Black, White, and Gray.

workspace_id

String

Workspace ID.

confidence

Integer

Confidence. Value range: 80 to 100.

Table 10 indicator_type

Parameter

Type

Description

indicator_type

String

Indicator type.

id

String

Indicator type ID.

Table 11 environment

Parameter

Type

Description

vendor_type

String

Environment provider.

domain_id

String

Account ID.

region_id

String

Region ID.

project_id

String

Project ID.

Table 12 data_source

Parameter

Type

Description

source_type

Integer

Data source type. The value can be 1, 2, or 3. 1: Huawei Cloud product; 2: Third-party products, and 3: Your in-house products.

domain_id

String

Account ID.

project_id

String

Project ID.

region_id

String

Region ID.

Table 13 DataClassRefPojo

Parameter

Type

Description

id

String

Data class ID.

name

String

Data class name.

Status code: 400

Table 14 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Table 15 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error description.

Example Requests

Query the threat indicator list. IDs: id1 and id2; Name: indicator name; Type: DATA_SOURCE; Data class ID: 28f61af50fc9452aa0ed5ea25c3cc3d3; Offset: 0. A maximum of 10 indicators can be included. Returned indicators are sorted by create_time.

{
  "ids" : [ "id1", "id2" ],
  "dataclass_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
  "condition" : {
    "conditions" : [ {
      "name" : "name",
      "data" : [ "name", "=", "Threat indicator name." ]
    } ],
    "logics" : [ "title" ]
  },
  "offset" : 0,
  "limit" : 10,
  "sort_by" : "create_time",
  "from_date" : "2024-01-20T00:00:00.000Z+0800",
  "to_date" : "2024-01-26T23:59:59.999Z+0800"
}

Example Responses

Status code: 200

Response to a successful request.

{
  "code" : "00000000",
  "data" : [ {
    "create_time" : "2023-07-24T20:54:19Z+0800",
    "data_object" : {
      "indicator_type" : {
        "indicator_type" : "ipv6",
        "id" : "ac794b2dfab9fe8c0676587301a636d3"
      },
      "revoked" : false,
      "workspace_id" : "d5baeef8-3e75-4e91-9826-fb208ac58987",
      "update_time" : "2023-07-24T20:54:19.038Z+0800",
      "project_id" : "15645222e8744afa985c93dab6341da6",
      "first_report_time" : "2023-07-31T20:54:12.000Z+0800",
      "id" : "ff61d1f8-0de4-4077-9e9b-e312f6829c6d",
      "granular_marking" : 1,
      "value" : "{}",
      "create_time" : "2023-07-24T20:54:19.038Z+0800",
      "confidence" : 80,
      "last_report_time" : "2023-07-25T20:54:15.000Z+0800",
      "data_source" : {
        "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4",
        "project_id" : "15645222e8744afa985c93dab6341da6",
        "region_id" : "xxx",
        "source_type" : 1
      },
      "environment" : {
        "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4",
        "project_id" : "15645222e8744afa985c93dab6341da6",
        "region_id" : "xxx",
        "vendor_type" : "xxx"
      },
      "verdict" : "Black",
      "name" : "test",
      "status" : "Open"
    },
    "dataclass_ref" : {
      "id" : "97ccf890-7480-31f6-a961-cf8da1f2f040",
      "name" : "name"
    },
    "id" : "ff61d1f8-0de4-4077-9e9b-e312f6829c6d",
    "update_time" : "2023-07-24T20:54:19Z+0800"
  } ],
  "message" : "",
  "total" : 2
}

SDK Sample Code

The SDK sample code is as follows.

Java

Query the threat indicator list. IDs: id1 and id2; Name: indicator name; Type: DATA_SOURCE; Data class ID: 28f61af50fc9452aa0ed5ea25c3cc3d3; Offset: 0. A maximum of 10 indicators can be included. Returned indicators are sorted by create_time.

 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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class ListIndicatorsSolution {

    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();
        ListIndicatorsRequest request = new ListIndicatorsRequest();
        request.withWorkspaceId("{workspace_id}");
        IndicatorListSearchRequest body = new IndicatorListSearchRequest();
        List<String> listConditionLogics = new ArrayList<>();
        listConditionLogics.add("title");
        List<String> listConditionsData = new ArrayList<>();
        listConditionsData.add("name");
        listConditionsData.add("=");
        listConditionsData.add("Threat indicator name.");
        List<IndicatorListSearchRequestConditionConditions> listConditionConditions = new ArrayList<>();
        listConditionConditions.add(
            new IndicatorListSearchRequestConditionConditions()
                .withName("name")
                .withData(listConditionsData)
        );
        IndicatorListSearchRequestCondition conditionbody = new IndicatorListSearchRequestCondition();
        conditionbody.withConditions(listConditionConditions)
            .withLogics(listConditionLogics);
        List<String> listbodyIds = new ArrayList<>();
        listbodyIds.add("id1");
        listbodyIds.add("id2");
        body.withToDate("2024-01-26T23:59:59.999Z+0800");
        body.withFromDate("2024-01-20T00:00:00.000Z+0800");
        body.withSortBy("create_time");
        body.withLimit(10);
        body.withOffset(0);
        body.withCondition(conditionbody);
        body.withDataclassId("28f61af50fc9452aa0ed5ea25c3cc3d3");
        body.withIds(listbodyIds);
        request.withBody(body);
        try {
            ListIndicatorsResponse response = client.listIndicators(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());
        }
    }
}

Python

Query the threat indicator list. IDs: id1 and id2; Name: indicator name; Type: DATA_SOURCE; Data class ID: 28f61af50fc9452aa0ed5ea25c3cc3d3; Offset: 0. A maximum of 10 indicators can be included. Returned indicators are sorted by create_time.

 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
54
55
56
57
58
59
60
61
62
63
64
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 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 = ListIndicatorsRequest()
        request.workspace_id = "{workspace_id}"
        listLogicsCondition = [
            "title"
        ]
        listDataConditions = [
            "name",
            "=",
            "Threat indicator name."
        ]
        listConditionsCondition = [
            IndicatorListSearchRequestConditionConditions(
                name="name",
                data=listDataConditions
            )
        ]
        conditionbody = IndicatorListSearchRequestCondition(
            conditions=listConditionsCondition,
            logics=listLogicsCondition
        )
        listIdsbody = [
            "id1",
            "id2"
        ]
        request.body = IndicatorListSearchRequest(
            to_date="2024-01-26T23:59:59.999Z+0800",
            from_date="2024-01-20T00:00:00.000Z+0800",
            sort_by="create_time",
            limit=10,
            offset=0,
            condition=conditionbody,
            dataclass_id="28f61af50fc9452aa0ed5ea25c3cc3d3",
            ids=listIdsbody
        )
        response = client.list_indicators(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Query the threat indicator list. IDs: id1 and id2; Name: indicator name; Type: DATA_SOURCE; Data class ID: 28f61af50fc9452aa0ed5ea25c3cc3d3; Offset: 0. A maximum of 10 indicators can be included. Returned indicators are sorted by create_time.

 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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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.ListIndicatorsRequest{}
	request.WorkspaceId = "{workspace_id}"
	var listLogicsCondition = []string{
        "title",
    }
	var listDataConditions = []string{
        "name",
	    "=",
	    "Threat indicator name.",
    }
	nameConditions:= "name"
	var listConditionsCondition = []model.IndicatorListSearchRequestConditionConditions{
        {
            Name: &nameConditions,
            Data: &listDataConditions,
        },
    }
	conditionbody := &model.IndicatorListSearchRequestCondition{
		Conditions: &listConditionsCondition,
		Logics: &listLogicsCondition,
	}
	var listIdsbody = []string{
        "id1",
	    "id2",
    }
	toDateIndicatorListSearchRequest:= "2024-01-26T23:59:59.999Z+0800"
	fromDateIndicatorListSearchRequest:= "2024-01-20T00:00:00.000Z+0800"
	sortByIndicatorListSearchRequest:= "create_time"
	dataclassIdIndicatorListSearchRequest:= "28f61af50fc9452aa0ed5ea25c3cc3d3"
	request.Body = &model.IndicatorListSearchRequest{
		ToDate: &toDateIndicatorListSearchRequest,
		FromDate: &fromDateIndicatorListSearchRequest,
		SortBy: &sortByIndicatorListSearchRequest,
		Limit: int32(10),
		Offset: int32(0),
		Condition: conditionbody,
		DataclassId: &dataclassIdIndicatorListSearchRequest,
		Ids: &listIdsbody,
	}
	response, err := client.ListIndicators(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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 a successful request.

400

Response message for failed requests.

Error Codes

See Error Codes.