# 查询投递信息 - ListShippers #### 功能介绍 查询投递信息 #### 调用方法 请参见[如何调用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 GET /v1/{project_id}/workspaces/{workspace_id}/siem/shippers 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | dataspace_id | 否 | String | 数据空间ID | | pipe_id | 否 | String | 管道ID | | shipper_name | 否 | String | 投递名称 | | shipper_source_region | 否 | String | 数据源区域 | | shipper_source_strategy | 否 | String | 数据源消费策略 | | shipper_consumption_type | 否 | String | 数据源消费类型 | | destination_shipper_type | 否 | String | 目的投递类型 | | shipper_status | 否 | String | 数据投递状态 | | create_time | 否 | String | 创建时间 | | limit | 否 | Long | 每页数量 | | offset | 否 | Long | 第几页 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | Integer | 错误码，0表示成功，其他值表示错误 | | data | [ApiResponseData] object | 数据信息 | | msg | String | 返回的状态信息，用于描述当前请求的结果 | 表5ApiResponseData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Array of [ApiResponseDataItem] objects | 结果数据 | | limit | Integer | 每页显示的记录数 | | offset | Integer | 当前页的起始偏移量 | | total | Integer | 总记录数 | 表6ApiResponseDataItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | consumption_type | Integer | 消费类型，具体含义根据业务定义 | | create_time | Long | 创建时间，单位为毫秒的时间戳 | | dataspace_id | String | 数据空间ID，唯一标识 | | dataspace_name | String | 数据空间名称 | | domain_id | String | 域ID，唯一标识 | | id | Integer | 唯一标识ID | | pipe_id | String | 管道ID，唯一标识 | | pipe_name | String | 管道名称 | | project_id | String | 项目ID，唯一标识 | | shipper_destination | [ShipperDestination] object | 投递目的 | | shipper_id | String | 船运ID，唯一标识 | | shipper_name | String | 船运名称 | | shipper_source | [ShipperSource] object | 投递源 | | status | Integer | 状态码，具体含义根据业务定义 | | update_time | Long | 更新时间，单位为毫秒的时间戳 | | version | String | 版本信息 | | workspace_id | String | 工作空间ID，唯一标识 | 表7ShipperDestination | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data_param | String | 数据参数，通常为JSON格式 | | data_type | Integer | 数据类型，具体含义根据业务定义 | | dataspace | String | 数据空间ID | | dataspace_name | String | 数据空间名称 | | destination_info | String | 目的详细信息 | | id | Integer | 唯一标识ID | | identity | String | 身份标识 | | pipe | String | 管道ID | | pipe_name | String | 管道名称 | | region | String | 地域信息 | | type | Integer | 类型码，具体含义根据业务定义 | | workspace | String | 工作空间ID | | workspace_name | String | 工作空间名称 | 表8ShipperSource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data_type | Integer | 数据类型，具体含义根据业务定义 | | dataspace | String | 数据空间ID | | dataspace_name | String | 数据空间名称 | | id | Integer | 唯一标识ID | | identity | String | 身份标识 | | pipe | String | 管道ID | | pipe_name | String | 管道名称 | | region | String | 地域信息 | | type | Integer | 类型码，具体含义根据业务定义 | | workspace | String | 工作空间ID | | workspace_name | String | 工作空间名称 | #### 请求示例 无 #### 响应示例 **状态码：200** 成功 ``` { "code" : 0, "data" : { "limit" : 1, "total" : 1, "data" : [ { "consumption_type" : 0, "create_time" : 1749539278902, "domain_id" : "0996e744f600f3180f34c014f001b7c0", "id" : 37, "project_id" : "c796dfc5f1644915ae072b7642a2cd93", "shipper_destination" : { "data_type" : 0, "destination_info" : "test", "id" : 92, "identity" : "table-strategy", "region" : "test-region", "type" : 1, "workspace" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155", "workspace_name" : "test" }, "shipper_id" : "dcda642e-29bd-44c4-8ba7-cb95e55be180", "shipper_name" : "ceshi", "shipper_source" : { "data_type" : 0, "id" : 91, "identity" : "table-strategy", "region" : "test-region", "type" : 0, "workspace" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155", "workspace_name" : "test" }, "status" : 0, "update_time" : 1749539278902, "version" : "v2", "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155" } ], "offset" : 0 }, "msg" : "success" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ListShippersSolution { 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(); ListShippersRequest request = new ListShippersRequest(); request.withWorkspaceId("{workspace_id}"); try { ListShippersResponse response = client.listShippers(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] ``` # 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 = ListShippersRequest() request.workspace_id = "{workspace_id}" response = client.list_shippers(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] ``` 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.ListShippersRequest{} request.WorkspaceId = "{workspace_id}" response, err := client.ListShippers(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=ListShippers&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。