Creating an Indicator
Function
Creating an Indicator
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/indicators
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 |
---|---|---|---|
data_object |
Yes |
CreateIndicatorDetail object |
Indicator details. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
data_source |
Yes |
data_source object |
Data source. |
verdict |
Yes |
String |
Threat Rating Minimum: 1 Maximum: 64 |
confidence |
No |
Integer |
Confidence level Minimum: 0 Maximum: 99 |
status |
No |
String |
Status Minimum: 1 Maximum: 64 |
labels |
No |
String |
Tag. Minimum: 1 Maximum: 64 |
value |
Yes |
String |
Value. Minimum: 1 Maximum: 128 |
granular_marking |
Yes |
String |
Confidentiality level. 1 -- First discovery; 2 -- Self-produced data; 3 -- Purchase required; and 4 -- Direct query from the external network. Minimum: 1 Maximum: 64 |
environment |
Yes |
environment object |
Environment Info |
defanged |
Yes |
Boolean |
Still valid? Default: false Enumeration values:
|
first_report_time |
Yes |
String |
First Occurred At Minimum: 0 Maximum: 64 |
last_report_time |
No |
String |
Last occurred. Minimum: 0 Maximum: 64 |
id |
No |
String |
Indicator ID. Minimum: 32 Maximum: 64 |
indicator_type |
Yes |
indicator_type object |
Indicator type statistics. |
name |
Yes |
String |
Indicator name. Minimum: 0 Maximum: 64 |
dataclass_id |
No |
String |
Data class ID. Minimum: 32 Maximum: 64 |
workspace_id |
Yes |
String |
workspace id Minimum: 32 Maximum: 64 |
project_id |
No |
String |
Project id value Minimum: 32 Maximum: 64 |
dataclass |
No |
DataClassRefPojo object |
Data class object information. |
create_time |
No |
String |
Create time Minimum: 0 Maximum: 64 |
update_time |
No |
String |
Update time Minimum: 0 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
source_type |
Yes |
Integer |
current page count Minimum: 0 Maximum: 9999 |
domain_id |
Yes |
String |
Id value Minimum: 32 Maximum: 64 |
project_id |
Yes |
String |
Id value Minimum: 32 Maximum: 64 |
region_id |
Yes |
String |
Id value Minimum: 1 Maximum: 64 |
product_name |
Yes |
String |
Id value Minimum: 1 Maximum: 64 |
product_feature |
Yes |
String |
Id value Minimum: 1 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
vendor_type |
Yes |
String |
Environment suppliers, such as HWC/AWS. Minimum: 0 Maximum: 1024 |
domain_id |
Yes |
String |
Tenant ID. Minimum: 32 Maximum: 64 |
region_id |
Yes |
String |
Region ID Minimum: 1 Maximum: 64 |
project_id |
Yes |
String |
Project ID. Minimum: 32 Maximum: 64 |
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 |
data |
IndicatorDetail object |
Indicator details. |
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 |
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
Create an indicator. The indicator name is Indicator Name, indicator version is 1, indicator type is DATA_SOURCE, and Trigger Flag is NO.
{ "data_object" : { "data_source" : { "source_type" : 3, "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "product_name" : "test", "product_feature" : "test" }, "verdict" : "BLACK", "confidence" : 4, "status" : "OPEN", "labels" : "OPEN", "value" : "{}", "granular_marking" : "1", "environment" : { "vendor_type" : "MyXXX", "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "defanged" : false, "first_report_time" : "2021-01-30T23:00:00Z+0800", "last_report_time" : "2021-01-30T23:00:00Z+0800", "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "indicator_type" : { }, "name" : "Indicator name.", "dataclass_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "dataclass" : { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "Name." }, "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800" } }
Example Responses
Status code: 200
Response when the request is successful.
{ "code" : 0, "message" : "Error message", "data" : { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "Indicator name.", "data_object" : { "indicator_type" : { "indicator_type" : "ipv6", "id" : "ac794b2dfab9fe8c0676587301a636d3" }, "value" : "ip", "data_source" : { "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4", "project_id" : "5b8bb3c888db498f9eeaf1023f7ba597", "region_id" : "cn-xxx-7", "source_type" : 1 }, "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "granular_marking" : 1, "first_report_time" : "2023-07-04T16:47:01Z+0800", "status" : "Open" }, "dataclass_ref" : { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "Name." }, "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800" } }
SDK Sample Code
The SDK sample code is as follows.
Create an indicator. The indicator name is Indicator Name, indicator version is 1, indicator type is DATA_SOURCE, and Trigger Flag is NO.
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 79 80 81 82 83 |
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.*; public class CreateIndicatorSolution { 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(); CreateIndicatorRequest request = new CreateIndicatorRequest(); IndicatorCreateRequest body = new IndicatorCreateRequest(); DataClassRefPojo dataclassDataObject = new DataClassRefPojo(); dataclassDataObject.withId("28f61af50fc9452aa0ed5ea25c3cc3d3") .withName("Name."); CreateIndicatorDetailEnvironment environmentDataObject = new CreateIndicatorDetailEnvironment(); environmentDataObject.withVendorType("MyXXX") .withDomainId("909494e3-558e-46b6-a9eb-07a8e18ca62f") .withRegionId("909494e3-558e-46b6-a9eb-07a8e18ca62f") .withProjectId("909494e3-558e-46b6-a9eb-07a8e18ca62f"); CreateIndicatorDetailDataSource dataSourceDataObject = new CreateIndicatorDetailDataSource(); dataSourceDataObject.withSourceType(3) .withDomainId("909494e3-558e-46b6-a9eb-07a8e18ca62f") .withProjectId("909494e3-558e-46b6-a9eb-07a8e18ca62f") .withRegionId("909494e3-558e-46b6-a9eb-07a8e18ca62f") .withProductName("test") .withProductFeature("test"); CreateIndicatorDetail dataObjectbody = new CreateIndicatorDetail(); dataObjectbody.withDataSource(dataSourceDataObject) .withVerdict("BLACK") .withConfidence(4) .withStatus("OPEN") .withLabels("OPEN") .withValue("{}") .withGranularMarking("1") .withEnvironment(environmentDataObject) .withDefanged(false) .withFirstReportTime("2021-01-30T23:00:00Z+0800") .withLastReportTime("2021-01-30T23:00:00Z+0800") .withId("28f61af50fc9452aa0ed5ea25c3cc3d3") .withName("Indicator name.") .withDataclassId("28f61af50fc9452aa0ed5ea25c3cc3d3") .withWorkspaceId("909494e3-558e-46b6-a9eb-07a8e18ca620") .withProjectId("909494e3-558e-46b6-a9eb-07a8e18ca62f") .withDataclass(dataclassDataObject) .withCreateTime("2021-01-30T23:00:00Z+0800") .withUpdateTime("2021-01-30T23:00:00Z+0800"); body.withDataObject(dataObjectbody); request.withBody(body); try { CreateIndicatorResponse response = client.createIndicator(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()); } } } |
Create an indicator. The indicator name is Indicator Name, indicator version is 1, indicator type is DATA_SOURCE, and Trigger Flag is NO.
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateIndicatorRequest() dataclassDataObject = DataClassRefPojo( id="28f61af50fc9452aa0ed5ea25c3cc3d3", name="Name." ) environmentDataObject = CreateIndicatorDetailEnvironment( vendor_type="MyXXX", domain_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", region_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", project_id="909494e3-558e-46b6-a9eb-07a8e18ca62f" ) dataSourceDataObject = CreateIndicatorDetailDataSource( source_type=3, domain_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", project_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", region_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", product_name="test", product_feature="test" ) dataObjectbody = CreateIndicatorDetail( data_source=dataSourceDataObject, verdict="BLACK", confidence=4, status="OPEN", labels="OPEN", value="{}", granular_marking="1", environment=environmentDataObject, defanged=False, first_report_time="2021-01-30T23:00:00Z+0800", last_report_time="2021-01-30T23:00:00Z+0800", id="28f61af50fc9452aa0ed5ea25c3cc3d3", name="Indicator name.", dataclass_id="28f61af50fc9452aa0ed5ea25c3cc3d3", workspace_id="909494e3-558e-46b6-a9eb-07a8e18ca620", project_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", dataclass=dataclassDataObject, create_time="2021-01-30T23:00:00Z+0800", update_time="2021-01-30T23:00:00Z+0800" ) request.body = IndicatorCreateRequest( data_object=dataObjectbody ) response = client.create_indicator(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create an indicator. The indicator name is Indicator Name, indicator version is 1, indicator type is DATA_SOURCE, and Trigger Flag is NO.
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 79 80 81 82 83 84 85 86 87 |
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.CreateIndicatorRequest{} nameDataclass:= "Name." dataclassDataObject := &model.DataClassRefPojo{ Id: "28f61af50fc9452aa0ed5ea25c3cc3d3", Name: &nameDataclass, } environmentDataObject := &model.CreateIndicatorDetailEnvironment{ VendorType: "MyXXX", DomainId: "909494e3-558e-46b6-a9eb-07a8e18ca62f", RegionId: "909494e3-558e-46b6-a9eb-07a8e18ca62f", ProjectId: "909494e3-558e-46b6-a9eb-07a8e18ca62f", } dataSourceDataObject := &model.CreateIndicatorDetailDataSource{ SourceType: int32(3), DomainId: "909494e3-558e-46b6-a9eb-07a8e18ca62f", ProjectId: "909494e3-558e-46b6-a9eb-07a8e18ca62f", RegionId: "909494e3-558e-46b6-a9eb-07a8e18ca62f", ProductName: "test", ProductFeature: "test", } confidenceDataObject:= int32(4) statusDataObject:= "OPEN" labelsDataObject:= "OPEN" lastReportTimeDataObject:= "2021-01-30T23:00:00Z+0800" idDataObject:= "28f61af50fc9452aa0ed5ea25c3cc3d3" dataclassIdDataObject:= "28f61af50fc9452aa0ed5ea25c3cc3d3" projectIdDataObject:= "909494e3-558e-46b6-a9eb-07a8e18ca62f" createTimeDataObject:= "2021-01-30T23:00:00Z+0800" updateTimeDataObject:= "2021-01-30T23:00:00Z+0800" dataObjectbody := &model.CreateIndicatorDetail{ DataSource: dataSourceDataObject, Verdict: "BLACK", Confidence: &confidenceDataObject, Status: &statusDataObject, Labels: &labelsDataObject, Value: "{}", GranularMarking: "1", Environment: environmentDataObject, Defanged: false, FirstReportTime: "2021-01-30T23:00:00Z+0800", LastReportTime: &lastReportTimeDataObject, Id: &idDataObject, Name: "Indicator name.", DataclassId: &dataclassIdDataObject, WorkspaceId: "909494e3-558e-46b6-a9eb-07a8e18ca620", ProjectId: &projectIdDataObject, Dataclass: dataclassDataObject, CreateTime: &createTimeDataObject, UpdateTime: &updateTimeDataObject, } request.Body = &model.IndicatorCreateRequest{ DataObject: dataObjectbody, } response, err := client.CreateIndicator(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