# 列出所有数据对象 - ListDataobjects #### 功能介绍 列出所有数据对象 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}/search 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间id。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | dataclass_name | 是 | String | 关联主体数据对象所属数据类名称，小写复数，如告警为alerts，事件为incidents | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 分页大小 | | offset | 否 | Integer | 偏移量 | | sort_by | 否 | String | 排序字段：create_time \| update_time | | order | 否 | String | 排序方式：DESC \| ASC | | from_date | 否 | String | 搜索开始时间，例如：2023-02-20T00:00:00.000Z | | to_date | 否 | String | 搜索结束时间，例如：2023-02-27T23:59:59.999Z | | condition | 否 | [condition] object | 搜索条件表达式 | 表4condition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | conditions | 否 | Array of [conditions] objects | 表达式列表 | | logics | 否 | Array of strings | 表达式名称列表 | 表5conditions | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 表达式名称 | | data | 否 | Array of strings | 表达式内容列表 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码 | | message | String | 错误信息 | | total | Integer | 总数 | | size | Integer | 分页大小 | | page | Integer | 分页的页码 | | success | Boolean | 是否成功 | | data | Array of [DataObjectDetail] objects | 详情列表 | 表7DataObjectDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_time | String | 记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 | | data_object | Object | 数据对象 | | dataclass_ref | [dataclass_ref] object | 数据类对象 | | format_version | Integer | 格式版本 | | id | String | 事件唯一标识，UUID格式，最大36个字符 | | project_id | String | 当前项目的id | | update_time | String | 更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 | | version | Integer | 版本 | | workspace_id | String | 当前的工作空间id | 表8dataclass_ref | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 数据类唯一标识，UUID格式，最大36个字符 | | name | String | 数据类名称 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释:** 错误码 **约束限制:** 不涉及 **取值范围:** 长度为0-64个字符 **默认取值:** 不涉及 | | message | String | **参数解释:** 错误描述 **约束限制:** 不涉及 **取值范围:** 长度为0-1024个字符 **默认取值:** 不涉及 | #### 请求示例 查询数据对象列表请求样例，返回第1页，每页10条数据 ``` https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}/search { "limit" : 10, "offset" : 0 } ``` #### 响应示例 **状态码：200** 查询数据对象列表返回body体 ``` { "code" : "00000000", "message" : "message", "total" : 1, "size" : 10, "page" : 0, "success" : true, "data" : [ { "create_time" : "2023-02-25T12:00:29.623Z+0800", "format_version" : 1, "id" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca626", "update_time" : "2023-02-27T20:28:53.001Z+0800", "version" : 0, "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca624", "data_object" : { "parent_id" : 0, "name" : "demo_name" }, "dataclass_ref" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "name" : "Department" } } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询数据对象列表请求样例，返回第1页，每页10条数据 ``` 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 ListDataobjectsSolution { 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("")) .build(); ListDataobjectsRequest request = new ListDataobjectsRequest(); request.withWorkspaceId("{workspace_id}"); request.withDataclassName("{dataclass_name}"); DataobjectSearch body = new DataobjectSearch(); body.withOffset(0); body.withLimit(10); request.withBody(body); try { ListDataobjectsResponse response = client.listDataobjects(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] 查询数据对象列表请求样例，返回第1页，每页10条数据 ``` # 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("")) \ .build() try: request = ListDataobjectsRequest() request.workspace_id = "{workspace_id}" request.dataclass_name = "{dataclass_name}" request.body = DataobjectSearch( offset=0, limit=10 ) response = client.list_dataobjects(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] 查询数据对象列表请求样例，返回第1页，每页10条数据 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ListDataobjectsRequest{} request.WorkspaceId = "{workspace_id}" request.DataclassName = "{dataclass_name}" offsetDataobjectSearch:= int32(0) limitDataobjectSearch:= int32(10) request.Body = &model.DataobjectSearch{ Offset: &offsetDataobjectSearch, Limit: &limitDataobjectSearch, } response, err := client.ListDataobjects(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ListDataobjects&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询数据对象列表返回body体 | | 400 | 查询数据对象列表错误返回body体 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。