文档首页/ 安全云脑 SecMaster/ API参考/ API/ 事件关系管理/ 查询关联Dataobject列表

更新时间：2024-10-22 GMT+08:00

在线调试

CLI示例

查看PDF

查询关联Dataobject列表

功能介绍

查询关联Dataobject列表

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_type}/{data_object_id}/{related_dataclass_type}/search

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目id 最小长度：32 最大长度：36
workspace_id	是	String	工作空间id 最小长度：32 最大长度：36
dataclass_type	是	String	关联主体dataobject所属数据类，小写复数，如告警为alerts，事件为incidents 最小长度：1 最大长度：64
data_object_id	是	String	关联主体dataobject的id 最小长度：32 最大长度：36
related_dataclass_type	是	String	被关联的dataobject所属数据类，小写复数，如告警为alerts，事件为incidents 最小长度：1 最大长度：64

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）最小长度：0 最大长度：2097152
content-type	是	String	内容类型缺省值：application/json;charset=UTF-8 最小长度：0 最大长度：64

表3 请求Body参数
参数	是否必选	参数类型	描述
limit	否	Integer	分页大小最小值：0 最大值：1000
offset	否	Integer	偏移量最小值：0 最大值：1000
sort_by	否	String	排序字段：create_time \| update_time 最小长度：0 最大长度：1000
order	否	String	排序方式：DESC \| ASC 最小长度：0 最大长度：1000 枚举值： DESC ASC
from_date	否	String	搜索开始时间，例如：2023-02-20T00:00:00.000Z 最小长度：0 最大长度：64
to_date	否	String	搜索结束时间，例如：2023-02-27T23:59:59.999Z 最小长度：0 最大长度：64
condition	否	condition object	搜索条件表达式

表4 condition
参数	是否必选	参数类型	描述
conditions	否	Array of conditions objects	表达式列表数组长度：0 - 999
logics	否	Array of strings	表达式名称列表最小长度：0 最大长度：100 数组长度：0 - 999

表5 conditions
参数	是否必选	参数类型	描述
name	否	String	表达式名称最小长度：0 最大长度：64
data	否	Array of strings	表达式内容列表最小长度：0 最大长度：100 数组长度：0 - 999

响应参数

状态码： 200

表6 响应Header参数
参数	参数类型	描述
X-request-id	String	请求ID，格式为：request_uuid-timestamp-hostname

表7 响应Body参数
参数	参数类型	描述
code	String	错误码最小长度：0 最大长度：64
message	String	错误信息最小长度：0 最大长度：1024
total	Integer	告警总数最小值：0 最大值：10000
limit	Integer	分页大小最小值：0 最大值：10000
offset	Integer	偏移量最小值：0 最大值：10000
success	Boolean	是否成功
data	Array of DataObjectDetail objects	告警列表数组长度：0 - 10000

表8 DataObjectDetail
参数	参数类型	描述
create_time	String	记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
data_object	DataObject object	告警实体信息
dataclass_ref	dataclass_ref object	数据类对象
format_version	Integer	格式版本最小值：0 最大值：999
id	String	事件唯一标识，UUID格式，最大36个字符最小长度：0 最大长度：36
project_id	String	当前项目的id 最小长度：0 最大长度：64
update_time	String	更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
version	Integer	版本最小值：0 最大值：999
workspace_id	String	当前的工作空间id 最小长度：0 最大长度：36

表9 DataObject
参数	参数类型	描述
version	String	告警对象的版本，该字段的值必须为华为云SSA服务确定的官方发布版本之一最小长度：0 最大长度：64
id	String	事件唯一标识，UUID格式，最大36个字符最小长度：0 最大长度：36
domain_id	String	数据投递后，被委托用户的domain_id 最小长度：0 最大长度：36
region_id	String	数据投递后，被委托用户的region_id 最小长度：0 最大长度：36
workspace_id	String	当前的工作空间id 最小长度：0 最大长度：36
environment	environment object	告警产生的环境坐标信息
datasource	datasource object	首次上报数据源
first_observed_time	String	首次发现时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
last_observed_time	String	最近发现时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
create_time	String	记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
arrive_time	String	接收时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
title	String	告警标题最小长度：0 最大长度：255
description	String	告警描述信息最小长度：0 最大长度：1024
source_url	String	告警URL链接，指向数据源产品中有关当前事件说明的页面最小长度：0 最大长度：1024
count	Integer	事件发生次数最小值：0 最大值：999
confidence	Integer	事件的置信度。置信度的定义旨在说明识别的行为或问题的可能性。取值范围：0-100，0表示置信度为0%，100表示置信度为100% 最小值：0 最大值：100
severity	String	严重性等级，取值范围：Tips \| Low \| Medium \| High \| Fatal 说明： 0: Tips – 未发现任何问题。 1: Low – 无需针对问题执行任何操作。 2: Medium – 问题需要处理，但不紧急。 3: High – 问题必须优先处理。 4: Fatal – 问题必须立即处理，以防止产生进一步的损害最小长度：3 最大长度：6 枚举值： Tips Low Medium High Fatal
criticality	Integer	关键性，是指事件涉及的资源的重要性级别。取值范围：0-100，0表示资源不关键，100表示最关键资源最小值：0 最大值：100
alert_type	alert_type object	告警分类，详细定义参考《告警类型定义》
network_list	Array of network_list objects	网络信息数组长度：0 - 999
resource_list	Array of resource_list objects	受影响资源数组长度：0 - 999
remediation	remediation object	补救措施
verification_state	String	验证状态，标识事件的准确性。可选类型如下： Unknown – 未知 True_Positive – 确认 False_Positive – 误报默认填写Unknown 最小长度：32 最大长度：64 枚举值： Unknown True_Positive False_Positive
handle_status	String	事件处理状态，可选类型如下： Open – 打开，默认 Block – 阻塞 Closed – 关闭默认填写Open 最小长度：4 最大长度：5 枚举值： Open Block Closed
sla	Integer	约束闭环时间：设置风险接受持续时间。单位：小时最小值：0 最大值：999
update_time	String	更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
close_time	String	关闭时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
ipdrr_phase	String	周期/处置阶段编号 Prepartion\|Detection and Analysis\|Containm，Eradication& Recovery\|Post-Incident-Activity 最小长度：0 最大长度：64 枚举值： Prepartion Detection and Analysis Containm，Eradication& Recovery Post-Incident-Activity
simulation	String	调试字段最小长度：0 最大长度：64
actor	String	告警调查员最小长度：0 最大长度：64
owner	String	责任人、服务责任人最小长度：0 最大长度：64
creator	String	创建人最小长度：0 最大长度：64
close_reason	String	关闭原因: 误检 - False detection 已解决 - Resolved 重复 - Repeated 其他 - Other 最小长度：0 最大长度：64 枚举值： False detection Resolved Repeated Other
close_comment	String	关闭评论最小长度：0 最大长度：1024
malware	malware object	恶意软件
system_info	Object	系统信息
process	Array of process objects	进程信息数组长度：0 - 999
user_info	Array of user_info objects	用户信息数组长度：0 - 999
file_info	Array of file_info objects	文件信息数组长度：0 - 999

**表10** environment
参数	参数类型	描述
vendor_type	String	环境供应商：HWCP/HWC/AWS/Azure/GCP 最小长度：0 最大长度：64
domain_id	String	租户id 最小长度：0 最大长度：64
region_id	String	区域id，全局服务global 最小长度：0 最大长度：64
cross_workspace_id	String	数据投递前的源工作空间id，在源空间下值为null，投递后为被委托用户的id 最小长度：0 最大长度：64
project_id	String	项目id，全局服务默认null 最小长度：0 最大长度：64

**表11** datasource
参数	参数类型	描述
source_type	Integer	数据源类型，取值范围如下： 1：华为云产品 2：第三方产品 3：租户私有产品最小值：1 最大值：3 枚举值： 1 2 3
domain_id	String	数据源产品所属账号的id 最小长度：0 最大长度：36
project_id	String	数据源产品所属项目的id 最小长度：0 最大长度：64
region_id	String	数据源产品所在区域，具体取值范围查看华为云地区和终端节点定义最小长度：0 最大长度：64
company_name	String	数据源产品所属公司的名称最小长度：0 最大长度：16
product_name	String	数据源产品的名称最小长度：0 最大长度：24
product_feature	String	产品功能特性名称，用来指明检测到当前事件的产品的功能特性最小长度：0 最大长度：24
product_module	String	检测模块列表最小长度：0 最大长度：1024

**表12** alert_type
参数	参数类型	描述
category	String	类别最小长度：0 最大长度：1024
alert_type	String	告警类型最小长度：0 最大长度：1024

**表13** network_list
参数	参数类型	描述
direction	String	方向，取值范围：IN \| OUT 最小长度：0 最大长度：3 枚举值： IN OUT
protocol	String	协议，包含7层和4层的协议参考：IANA registered name https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml 最小长度：0 最大长度：64
src_ip	String	源IP地址最小长度：0 最大长度：64
src_port	Integer	源端口，0–65535 最小值：0 最大值：65535
src_domain	String	源域名最小长度：0 最大长度：128
src_geo	src_geo object	源IP的地理位置信息
dest_ip	String	目的IP地址最小长度：32 最大长度：64
dest_port	String	目的端口，0–65535 最小长度：0 最大长度：65535
dest_domain	String	目的域名最小长度：0 最大长度：128
dest_geo	dest_geo object	目标IP的地理位置信息

**表14** src_geo
参数	参数类型	描述
latitude	Number	纬度最小值：0 最大值：90
longitude	Number	经度最小值：0 最大值：180
city_code	String	城市编码，Beijing \| Shanghai 最小长度：0 最大长度：64
country_code	String	国家简码，参考ISO 3166-1 alpha-2，例如：CN \| US \| DE \| IT \| SG 最小长度：0 最大长度：64

**表15** dest_geo
参数	参数类型	描述
latitude	Number	纬度最小值：0 最大值：90
longitude	Number	经度最小值：0 最大值：180
city_code	String	城市编码，Beijing \| Shanghai 最小长度：0 最大长度：64
country_code	String	国家简码，参考ISO 3166-1 alpha-2，例如：CN \| US \| DE \| IT \| SG 最小长度：0 最大长度：64

**表16** resource_list
参数	参数类型	描述
id	String	云服务资源id 最小长度：0 最大长度：36
name	String	资源名称最小长度：0 最大长度：255
type	String	资源类型；引用华为云RMS type字段最小长度：0 最大长度：64
provider	String	云服务名称；引用华为云RMS provider字段最小长度：0 最大长度：64
region_id	String	区域；按照华为云regionId填写最小长度：0 最大长度：36
domain_id	String	资源所属账号ID，UUID格式最小长度：0 最大长度：36
project_id	String	资源所属项目ID，UUID格式最小长度：0 最大长度：36
ep_id	String	企业项目id 最小长度：0 最大长度：128
ep_name	String	企业项目名称最小长度：0 最大长度：128
tags	String	资源标签 1、最多50个key/values对 2、values：最大255字符，取值范围：字母数字,空格,+, -, =, ., _, :, /,@ 最小长度：0 最大长度：2048

**表17** remediation
参数	参数类型	描述
recommendation	String	推荐处理方法最小长度：0 最大长度：128
url	String	链接，指向该事件的一般修复信息。该URL必须可以从公网访问，不需要提供凭证最小长度：0 最大长度：2048

**表18** malware
参数	参数类型	描述
malware_family	String	恶意家族最小长度：0 最大长度：64
malware_class	String	恶意软件分类最小长度：0 最大长度：64

**表19** process
参数	参数类型	描述
process_name	String	进程名最小长度：0 最大长度：64
process_path	String	进程执行文件路径最小长度：0 最大长度：512
process_pid	Integer	进程id 最小值：0 最大值：65535
process_uid	Integer	进程用户id 最小值：0 最大值：655350
process_cmdline	String	进程命令行最小长度：0 最大长度：128
process_parent_name	String	父进程名称最小长度：0 最大长度：64
process_parent_path	String	父进程执行文件路径最小长度：0 最大长度：512
process_parent_pid	Integer	父进程id 最小值：0 最大值：65535
process_parent_uid	Integer	父进程用户id 最小值：0 最大值：655350
process_parent_cmdline	String	父进程命令行最小长度：0 最大长度：128
process_child_name	String	子进程名称最小长度：0 最大长度：64
process_child_path	String	子进程执行文件路径最小长度：0 最大长度：512
process_child_pid	Integer	子进程id 最小值：0 最大值：65535
process_child_uid	Integer	子进程用户id 最小值：0 最大值：655350
process_child_cmdline	String	子进程命令行最小长度：0 最大长度：128
process_launche_time	String	进程启动时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30
process_terminate_time	String	进程结束时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区最小长度：0 最大长度：30

**表20** user_info
参数	参数类型	描述
user_id	String	用户uid 最小长度：0 最大长度：36
user_name	String	用户名称最小长度：32 最大长度：64

**表21** file_info
参数	参数类型	描述
file_path	String	文件路径/名称最小长度：0 最大长度：128
file_content	String	文件内容最小长度：0 最大长度：1024
file_new_path	String	文件新路径/名称最小长度：32 最大长度：64
file_hash	String	文件hash 最小长度：0 最大长度：128
file_md5	String	文件md5 最小长度：0 最大长度：128
file_sha256	String	文件sha256 最小长度：0 最大长度：128
file_attr	String	文件属性最小长度：0 最大长度：1024

**表22** dataclass_ref
参数	参数类型	描述
id	String	数据类唯一标识，UUID格式，最大36个字符最小长度：0 最大长度：36
name	String	数据类名称最小长度：0 最大长度：36

状态码： 400

**表23** 响应Header参数
参数	参数类型	描述
X-request-id	String	请求ID，格式为：request_uuid-timestamp-hostname

**表24** 响应Body参数
参数	参数类型	描述
code	String	错误码最小长度：0 最大长度：64
message	String	错误描述最小长度：0 最大长度：1024

请求示例

查询数据对象的关系列表，偏移量为10，查询3条

{
  "limit" : 3,
  "offset" : 10
}

响应示例

状态码： 200

查询关联Dataobject列表返回body体

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "total" : 41,
  "limit" : 3,
  "offset" : 10,
  "data" : null
}

SDK代码示例

SDK代码示例如下。

查询数据对象的关系列表，偏移量为10，查询3条

      
       
         
         
           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 ListDataobjectRelationsSolution {

    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();
        ListDataobjectRelationsRequest request = new ListDataobjectRelationsRequest();
        DataobjectSearch body = new DataobjectSearch();
        body.withOffset(10);
        body.withLimit(3);
        request.withBody(body);
        try {
            ListDataobjectRelationsResponse response = client.listDataobjectRelations(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());
        }
    }
}

          

        

      
     

查询数据对象的关系列表，偏移量为10，查询3条

      
       
         
         
           # 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 = ListDataobjectRelationsRequest()
        request.body = DataobjectSearch(
            offset=10,
            limit=3
        )
        response = client.list_dataobject_relations(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

查询数据对象的关系列表，偏移量为10，查询3条

      
       
         
         
           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.ListDataobjectRelationsRequest{}
	offsetDataobjectSearch:= int32(10)
	limitDataobjectSearch:= int32(3)
	request.Body = &model.DataobjectSearch{
		Offset: &offsetDataobjectSearch,
		Limit: &limitDataobjectSearch,
	}
	response, err := client.ListDataobjectRelations(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	查询关联Dataobject列表返回body体
400	查询关联Dataobject列表错误返回body体

错误码

请参见错误码。

父主题：事件关系管理

上一篇：事件关系管理

下一篇：关联Dataobject

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消