# 获取数据管道详情 - ShowPipe #### 功能介绍 获取数据管道详情 #### 调用方法 请参见[如何调用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/pipes/{pipe_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | pipe_id | 是 | String | 管道ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | 资源类型，例如 STREAMING_TO_INDEX | | create_by | String | 创建者信息 | | create_time | Long | 创建时间戳 | | delete_time | Integer | 删除时间戳 | | description | String | 描述信息 | | directory | String | 目录路径 | | owner_type | String | 所有者类型，例如 USER | | pipe_alias | String | 管道别名 | | pipe_id | String | 管道ID | | pipe_name | String | 管道名称 | | process_error | String | 处理错误状态，例如 NONE | | process_status | String | 处理状态，例如 COMPLETED | | project_id | String | 项目ID | | resources | Array of [IsapResource] objects | 资源列表 | | schema | [Schema] object | 格式 | | storage_setting | [StorageSetting] object | 存储设置 | | update_by | String | 更新者信息 | | update_time | Long | 更新时间戳 | | workspace_id | String | 工作空间ID | 表4IsapResource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | 资源类型，例如 STREAMING 或 INDEX | | create_by | String | 创建者信息 | | create_time | Integer | 创建时间戳 | | data_classification | String | 数据分类，例如 FACTUAL_DATA | | data_layering | String | 数据分层，例如 ODS | | delete_time | Integer | 删除时间戳 | | description | String | 描述信息 | | directory | String | 目录路径 | | display_setting | [display_setting] object | 显示设置 | | format | String | 数据格式，例如 JSON | | lock_status | String | 锁定状态，例如 UNLOCKED | | owner_type | String | 所有者类型，例如 USER | | pipe_id | String | 管道ID | | process_error | String | 处理错误状态，例如 NONE | | process_status | String | 处理状态，例如 COMPLETED | | project_id | String | 项目ID | | rw_type | String | 读写类型，例如 READ_WRITE | | schema | [Schema] object | 格式 | | storage_setting | [StorageSetting] object | 存储设置 | | store_size_in_bytes | Integer | 存储大小（字节） | | table_alias | String | 表别名 | | table_id | String | 表ID | | table_name | String | 表名称 | | update_by | String | 更新者信息 | | update_time | Integer | 更新时间戳 | | workspace_id | String | 工作空间ID | 表5display_setting | 参数 | 参数类型 | 描述 | |:---|:---|:---| | columns | Array of [columns] objects | 列 | | format | String | 显示格式，例如 TABLE | 表6columns | 参数 | 参数类型 | 描述 | |:---|:---|:---| | column_alias | String | 列别名 | | column_name | String | 列名称 | | display_by_default | Boolean | 是否默认显示 | 表7Schema | 参数 | 参数类型 | 描述 | |:---|:---|:---| | columns | Array of [columns] objects | 列 | | partition | Array of strings | 分区 | | primary_key | Array of strings | 主键 | | time_filter | String | 时间过滤列 | | watermark_column | String | 水印列 | | watermark_interval | Number | 水印间隔 | 表8columns | 参数 | 参数类型 | 描述 | |:---|:---|:---| | array | Boolean | 是否为数组 | | column_data_type | String | 列数据类型，例如 TIMESTAMP 或 INT | | column_data_type_setting | String | 数据类型设置 | | column_name | String | 列名称 | | column_sequence_number | Integer | 列顺序号 | | column_type | String | 列类型，例如 PHYSICAL | | column_type_setting | String | 列类型设置 | | depth | Integer | 深度 | | nullable | Boolean | 是否允许为空 | | own_name | String | 自有名称 | | parent_name | String | 父名称 | 表9StorageSetting | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data_transformation_cu | Number | 数据转换 CU | | index_replicas | Integer | 索引副本数 | | index_shards | Integer | 索引分片数 | | index_storage_period | Integer | 索引存储周期 | | index_storage_size | Integer | 索引存储大小 | | lake_storage_period | Integer | 湖存储周期 | | streaming_bandwidth | Number | 流式带宽 | | streaming_dataspace_id | String | 流式数据空间ID | | streaming_partition | Integer | 流式分区数 | | streaming_retention_size | Integer | 流式保留大小 | | streaming_retention_time | Integer | 流式保留时间 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 无 #### 响应示例 **状态码：200** 成功 ``` { "category" : "STREAMING_TO_INDEX", "create_by" : "test_user", "create_time" : 1754998254580, "delete_time" : 0, "description" : "test123", "directory" : "", "owner_type" : "USER", "pipe_alias" : "test", "pipe_id" : "7bdb801d-a761-451e-97bb-5c1d172ee442", "pipe_name" : "cp1_0812", "process_error" : "NONE", "process_status" : "COMPLETED", "project_id" : "c796dfc5f1644915ae072b7642a2cd93", "resources" : [ { "category" : "STREAMING", "create_by" : "test_user", "create_time" : 1754998254806, "data_classification" : "FACTUAL_DATA", "data_layering" : "ODS", "delete_time" : 0, "description" : "", "directory" : "", "display_setting" : { "columns" : [ { "column_alias" : "", "column_name" : "ctime", "display_by_default" : false }, { "column_alias" : "", "column_name" : "age", "display_by_default" : false }, { "column_alias" : "", "column_name" : "test_add", "display_by_default" : true } ], "format" : "TABLE" }, "format" : "JSON", "lock_status" : "UNLOCKED", "owner_type" : "USER", "pipe_id" : "7bdb801d-a761-451e-97bb-5c1d172ee442", "process_error" : "NONE", "process_status" : "COMPLETED", "project_id" : "c796dfc5f1644915ae072b7642a2cd93", "rw_type" : "READ_WRITE", "schema" : { "columns" : [ { "array" : false, "column_data_type" : "TIMESTAMP", "column_data_type_setting" : "3", "column_name" : "ctime", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "ctime", "parent_name" : "" }, { "array" : false, "column_data_type" : "INT", "column_data_type_setting" : "", "column_name" : "age", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "age", "parent_name" : "" }, { "array" : false, "column_data_type" : "BIGINT", "column_data_type_setting" : "", "column_name" : "test_add", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "test_add", "parent_name" : "" } ], "partition" : [ ], "primary_key" : [ ], "time_filter" : "ctime", "watermark_column" : "ctime", "watermark_interval" : 5 }, "storage_setting" : { "streaming_bandwidth" : 0.5, "streaming_dataspace_id" : "f5f1e499-005e-4ad6-8c64-d6bb4b3135f1", "streaming_partition" : 1, "streaming_retention_size" : 2048, "streaming_retention_time" : 120 }, "store_size_in_bytes" : 0, "table_alias" : "Streaming_test", "table_id" : "d22b2659-d84c-4bfd-8c1c-889b7c5f7e36", "table_name" : "s_cp1_0812", "update_by" : "test_user", "update_time" : 1768383762008, "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155" }, { "category" : "INDEX", "create_by" : "test_user", "create_time" : 1754998267216, "data_classification" : "FACTUAL_DATA", "data_layering" : "ODS", "delete_time" : 0, "description" : "", "directory" : "", "display_setting" : { "columns" : [ { "column_alias" : "", "column_name" : "ctime", "display_by_default" : false }, { "column_alias" : "", "column_name" : "age", "display_by_default" : false }, { "column_alias" : "", "column_name" : "test_add", "display_by_default" : true } ], "format" : "TABLE" }, "format" : "JSON", "lock_status" : "UNLOCKED", "owner_type" : "USER", "pipe_id" : "7bdb801d-a761-451e-97bb-5c1d172ee442", "process_error" : "NONE", "process_status" : "COMPLETED", "project_id" : "c796dfc5f1644915ae072b7642a2cd93", "rw_type" : "READ_WRITE", "schema" : { "columns" : [ { "array" : false, "column_data_type" : "TIMESTAMP", "column_data_type_setting" : "3", "column_name" : "ctime", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "ctime", "parent_name" : "" }, { "array" : false, "column_data_type" : "INT", "column_data_type_setting" : "", "column_name" : "age", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "age", "parent_name" : "" }, { "array" : false, "column_data_type" : "BIGINT", "column_data_type_setting" : "", "column_name" : "test_add", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "test_add", "parent_name" : "" } ], "partition" : [ ], "primary_key" : [ ], "time_filter" : "ctime", "watermark_column" : "ctime", "watermark_interval" : 5 }, "storage_setting" : { "index_replicas" : 1, "index_shards" : 1, "index_storage_period" : 3, "index_storage_size" : 100 }, "store_size_in_bytes" : 0, "table_alias" : "Index_test", "table_id" : "0114aa4c-5a1b-4333-a970-2026b15a98f3", "table_name" : "i_cp1_0812", "update_by" : "test_user", "update_time" : 1768383768880, "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155" }, { "category" : "STREAMING", "create_by" : "test_user", "create_time" : 1754998254806, "data_classification" : "FACTUAL_DATA", "data_layering" : "ODS", "delete_time" : 0, "description" : "", "directory" : "", "display_setting" : { "columns" : [ { "column_alias" : "", "column_name" : "ctime", "display_by_default" : false }, { "column_alias" : "", "column_name" : "age", "display_by_default" : false }, { "column_alias" : "", "column_name" : "test_add", "display_by_default" : true } ], "format" : "TABLE" }, "format" : "JSON", "lock_status" : "UNLOCKED", "owner_type" : "USER", "pipe_id" : "7bdb801d-a761-451e-97bb-5c1d172ee442", "process_error" : "NONE", "process_status" : "COMPLETED", "project_id" : "c796dfc5f1644915ae072b7642a2cd93", "rw_type" : "READ_WRITE", "schema" : { "columns" : [ { "array" : false, "column_data_type" : "TIMESTAMP", "column_data_type_setting" : "3", "column_name" : "ctime", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "ctime", "parent_name" : "" }, { "array" : false, "column_data_type" : "INT", "column_data_type_setting" : "", "column_name" : "age", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "age", "parent_name" : "" }, { "array" : false, "column_data_type" : "BIGINT", "column_data_type_setting" : "", "column_name" : "test_add", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "test_add", "parent_name" : "" } ], "partition" : [ ], "primary_key" : [ ], "time_filter" : "ctime", "watermark_column" : "ctime", "watermark_interval" : 5 }, "storage_setting" : { "streaming_bandwidth" : 0.5, "streaming_dataspace_id" : "f5f1e499-005e-4ad6-8c64-d6bb4b3135f1", "streaming_partition" : 1, "streaming_retention_size" : 2048, "streaming_retention_time" : 120 }, "store_size_in_bytes" : 0, "table_alias" : "Streaming_test", "table_id" : "d22b2659-d84c-4bfd-8c1c-889b7c5f7e36", "table_name" : "s_cp1_0812", "update_by" : "test_user", "update_time" : 1768383762008, "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155" }, { "category" : "INDEX", "create_by" : "test_user", "create_time" : 1754998267216, "data_classification" : "FACTUAL_DATA", "data_layering" : "ODS", "delete_time" : 0, "description" : "", "directory" : "", "display_setting" : { "columns" : [ { "column_alias" : "", "column_name" : "ctime", "display_by_default" : false }, { "column_alias" : "", "column_name" : "age", "display_by_default" : false }, { "column_alias" : "", "column_name" : "test_add", "display_by_default" : true } ], "format" : "TABLE" }, "format" : "JSON", "lock_status" : "UNLOCKED", "owner_type" : "USER", "pipe_id" : "7bdb801d-a761-451e-97bb-5c1d172ee442", "process_error" : "NONE", "process_status" : "COMPLETED", "project_id" : "c796dfc5f1644915ae072b7642a2cd93", "rw_type" : "READ_WRITE", "schema" : { "columns" : [ { "array" : false, "column_data_type" : "TIMESTAMP", "column_data_type_setting" : "3", "column_name" : "ctime", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "ctime", "parent_name" : "" }, { "array" : false, "column_data_type" : "INT", "column_data_type_setting" : "", "column_name" : "age", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "age", "parent_name" : "" }, { "array" : false, "column_data_type" : "BIGINT", "column_data_type_setting" : "", "column_name" : "test_add", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "test_add", "parent_name" : "" } ], "partition" : [ ], "primary_key" : [ ], "time_filter" : "ctime", "watermark_column" : "ctime", "watermark_interval" : 5 }, "storage_setting" : { "index_replicas" : 1, "index_shards" : 1, "index_storage_period" : 3, "index_storage_size" : 100 }, "store_size_in_bytes" : 0, "table_alias" : "Index_test", "table_id" : "0114aa4c-5a1b-4333-a970-2026b15a98f3", "table_name" : "i_cp1_0812", "update_by" : "test_user", "update_time" : 1768383768880, "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155" }, { "create_by" : "test_user", "create_time" : 1754998279696, "delete_time" : 0, "description" : "test123", "directory" : "", "owner_type" : "SYSTEM", "pipe_id" : "7bdb801d-a761-451e-97bb-5c1d172ee442", "process_error" : "NONE", "process_status" : "COMPLETED", "project_id" : "c796dfc5f1644915ae072b7642a2cd93", "update_by" : "test_user", "update_time" : 1768382940577, "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155" } ], "schema" : { "columns" : [ { "array" : false, "column_data_type" : "TIMESTAMP", "column_data_type_setting" : "3", "column_name" : "ctime", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "ctime", "parent_name" : "" }, { "array" : false, "column_data_type" : "INT", "column_data_type_setting" : "", "column_name" : "age", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "age", "parent_name" : "" }, { "array" : false, "column_data_type" : "BIGINT", "column_data_type_setting" : "", "column_name" : "test_add", "column_sequence_number" : 0, "column_type" : "PHYSICAL", "column_type_setting" : "", "depth" : 0, "nullable" : true, "own_name" : "test_add", "parent_name" : "" } ], "partition" : [ ], "primary_key" : [ ], "time_filter" : "ctime", "watermark_column" : "ctime", "watermark_interval" : 5 }, "storage_setting" : { "data_transformation_cu" : 0.25, "index_shards" : 1, "index_storage_period" : 3, "index_storage_size" : 100, "lake_storage_period" : 0, "streaming_bandwidth" : 0.5, "streaming_dataspace_id" : "f5f1e499-005e-4ad6-8c64-d6bb4b3135f1", "streaming_partition" : 1 }, "update_by" : "test_user", "update_time" : 1768383768886, "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155" } ``` #### 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 ShowPipeSolution { 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(); ShowPipeRequest request = new ShowPipeRequest(); request.withWorkspaceId("{workspace_id}"); request.withPipeId("{pipe_id}"); try { ShowPipeResponse response = client.showPipe(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 = ShowPipeRequest() request.workspace_id = "{workspace_id}" request.pipe_id = "{pipe_id}" response = client.show_pipe(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.ShowPipeRequest{} request.WorkspaceId = "{workspace_id}" request.PipeId = "{pipe_id}" response, err := client.ShowPipe(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=ShowPipe&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | | 400 | 错误响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。