This API is used to query the intelligence indicator list.
Function
This API is used to query the intelligence indicator list.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/indicators/search
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 32 Maximum: 64 |
workspace_id |
Yes |
String |
Workspace ID Minimum: 1 Maximum: 1024 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Token of the tenant. Minimum: 32 Maximum: 65535 |
content-type |
Yes |
String |
application/json;charset=UTF-8 Default: application/json;charset=UTF-8 Minimum: 1 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ids |
No |
Array of strings |
List of indicator IDs. Minimum: 32 Maximum: 64 Array Length: 0 - 999 |
name |
No |
String |
Indicator name. Minimum: 0 Maximum: 64 |
dataclass_id |
No |
String |
Data class ID. Minimum: 32 Maximum: 64 |
condition |
Yes |
condition object |
Search condition expression. |
offset |
Yes |
Integer |
request offset, from 0 Minimum: 0 Maximum: 999999 Default: 0 |
limit |
Yes |
Integer |
request limit size Minimum: 1 Maximum: 999999 |
sort_by |
No |
String |
sort by property, create_time. Minimum: 1 Maximum: 64 |
from_date |
No |
String |
Query start time, for example, 2024-01-20T00:00:00.000Z+0800 Minimum: 0 Maximum: 64 |
to_date |
No |
String |
Query end time, for example, 2024-01-26T23:59:59.999Z+0800 Minimum: 0 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
conditions |
No |
Array of conditions objects |
Expression list. Array Length: 0 - 999 |
logics |
No |
Array of strings |
Expression logic. Minimum: 0 Maximum: 100 Array Length: 0 - 999 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code Minimum: 32 Maximum: 64 |
message |
String |
Error Message Minimum: 1 Maximum: 32 |
total |
Integer |
Total Minimum: 0 Maximum: 99999 |
data |
Array of IndicatorDetail objects |
List of indicators. Array Length: 0 - 100 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Indicator ID. Minimum: 32 Maximum: 64 |
name |
String |
Indicator name. Minimum: 0 Maximum: 64 |
data_object |
IndicatorDataObjectDetail object |
Indicator details |
workspace_id |
String |
Workspace ID Minimum: 32 Maximum: 64 |
project_id |
String |
Project ID. Minimum: 32 Maximum: 64 |
dataclass_ref |
DataClassRefPojo object |
Data class object information. |
create_time |
String |
Creation time. Minimum: 0 Maximum: 64 |
update_time |
String |
Update time. Minimum: 0 Maximum: 64 |
Parameter |
Type |
Description |
---|---|---|
indicator_type |
indicator_type object |
Indicator type object. |
value |
String |
Value, for example, ip url domain. Minimum: 0 Maximum: 256 |
update_time |
String |
Update time. Minimum: 0 Maximum: 64 |
create_time |
String |
Creation time. Minimum: 0 Maximum: 64 |
environment |
environment object |
Environment Info |
data_source |
data_source object |
Data source. |
first_report_time |
String |
First Occurred At Minimum: 0 Maximum: 64 |
is_deleted |
Boolean |
Delete |
last_report_time |
String |
Last occurred. Minimum: 0 Maximum: 64 |
granular_marking |
Integer |
Confidentiality level. 1 -- First discovery; 2 -- Self-produced data; 3 -- Purchase required; and 4 -- Direct query from the external network. Minimum: 1 Maximum: 4 |
name |
String |
Name. Minimum: 1 Maximum: 64 |
id |
String |
Indicator ID. Minimum: 1 Maximum: 64 |
project_id |
String |
Project ID. Minimum: 1 Maximum: 64 |
revoked |
Boolean |
Whether to discard. |
status |
String |
Status. The options are Open, Closed, and Revoked. Minimum: 1 Maximum: 64 |
verdict |
String |
Threat degree. The options are Black, White, and Gray. Minimum: 1 Maximum: 64 |
workspace_id |
String |
Workspace ID Minimum: 1 Maximum: 64 |
confidence |
Integer |
Confidence. The value range is 80 to 100. Minimum: 80 Maximum: 100 |
Parameter |
Type |
Description |
---|---|---|
indicator_type |
String |
Indicator type. Minimum: 1 Maximum: 32 |
id |
String |
Indicator type ID. Minimum: 1 Maximum: 64 |
category |
String |
Table of Contents Minimum: 1 Maximum: 64 |
layout_id |
String |
Layout ID. Minimum: 1 Maximum: 64 |
Parameter |
Type |
Description |
---|---|---|
vendor_type |
String |
Environment suppliers, such as HWC, AWS, and Azure. Minimum: 0 Maximum: 1024 |
domain_id |
String |
Tenant ID. Minimum: 32 Maximum: 64 |
region_id |
String |
Region ID Minimum: 1 Maximum: 64 |
project_id |
String |
Project ID. Minimum: 32 Maximum: 64 |
Parameter |
Type |
Description |
---|---|---|
source_type |
Integer |
Data source type. The options are as follows-- 1- Huawei product 2- Third-party product 3- Tenant product Minimum: 0 Maximum: 9999 |
domain_id |
String |
Tenant ID. Minimum: 32 Maximum: 64 |
project_id |
String |
Project ID. Minimum: 32 Maximum: 64 |
region_id |
String |
Region ID Minimum: 1 Maximum: 64 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Data class ID. Minimum: 32 Maximum: 64 |
name |
String |
Data class name. Minimum: 0 Maximum: 64 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error Code Minimum: 0 Maximum: 64 |
message |
String |
Error Description Minimum: 0 Maximum: 1024 |
Example Requests
Query the intelligence indicator list. IDs are id1 and id2; Name is indicator name; Type is DATA_SOURCE; Data class ID is 28f61af50fc9452aa0ed5ea25c3cc3d3; Offset is 0. A maximum of 10 indicators can be included, and sorted by create_time.
{ "ids" : [ "id1", "id2" ], "name" : "Indicator name.", "dataclass_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "condition" : { "conditions" : [ { "name" : "title", "data" : [ "title", "=", "Incident" ] } ], "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 when the request is successful.
{ "code" : "00000000", "data" : [ { "create_time" : "2023-07-24T20:54:19Z+0800", "data_object" : { "indicator_type" : { "layout_id" : "20e45c85-8192-3142-bfc8-54b784a80c69", "indicator_type" : "ipv6", "id" : "ac794b2dfab9fe8c0676587301a636d3", "category" : "ipv6" }, "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" : "cn-XXX-7", "source_type" : 1 }, "environment" : { "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4", "project_id" : "15645222e8744afa985c93dab6341da6", "region_id" : "cn-xxx-7", "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.
Query the intelligence indicator list. IDs are id1 and id2; Name is indicator name; Type is DATA_SOURCE; Data class ID is 28f61af50fc9452aa0ed5ea25c3cc3d3; Offset is 0. A maximum of 10 indicators can be included, and 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 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); ListIndicatorsRequest request = new ListIndicatorsRequest(); IndicatorListSearchRequest body = new IndicatorListSearchRequest(); List<String> listConditionLogics = new ArrayList<>(); listConditionLogics.add("title"); List<String> listConditionsData = new ArrayList<>(); listConditionsData.add("title"); listConditionsData.add("="); listConditionsData.add("Incident"); List<IndicatorListSearchRequestConditionConditions> listConditionConditions = new ArrayList<>(); listConditionConditions.add( new IndicatorListSearchRequestConditionConditions() .withName("title") .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.withName("Indicator name."); 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()); } } } |
Query the intelligence indicator list. IDs are id1 and id2; Name is indicator name; Type is DATA_SOURCE; Data class ID is 28f61af50fc9452aa0ed5ea25c3cc3d3; Offset is 0. A maximum of 10 indicators can be included, and 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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListIndicatorsRequest() listLogicsCondition = [ "title" ] listDataConditions = [ "title", "=", "Incident" ] listConditionsCondition = [ IndicatorListSearchRequestConditionConditions( name="title", 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", name="Indicator name.", 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) |
Query the intelligence indicator list. IDs are id1 and id2; Name is indicator name; Type is DATA_SOURCE; Data class ID is 28f61af50fc9452aa0ed5ea25c3cc3d3; Offset is 0. A maximum of 10 indicators can be included, and 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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListIndicatorsRequest{} var listLogicsCondition = []string{ "title", } var listDataConditions = []string{ "title", "=", "Incident", } nameConditions:= "title" 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" nameIndicatorListSearchRequest:= "Indicator name." request.Body = &model.IndicatorListSearchRequest{ ToDate: &toDateIndicatorListSearchRequest, FromDate: &fromDateIndicatorListSearchRequest, SortBy: &sortByIndicatorListSearchRequest, Limit: int32(10), Offset: int32(0), Condition: conditionbody, DataclassId: &dataclassIdIndicatorListSearchRequest, Name: &nameIndicatorListSearchRequest, Ids: &listIdsbody, } response, err := client.ListIndicators(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 when the request is successful. |
400 |
Response when the request failed. |
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