Obtaining Data Pipeline Details

Function

This API is used to obtain data pipeline details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/pipes/{pipe_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Value Range N/A Default value N/A
workspace_id	Yes	String	Workspace ID.
pipe_id	Yes	String	Pipeline ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
category	String	Resource type, for example, STREAMING_TO_INDEX.
create_by	String	Creator information.
create_time	Long	Creation timestamp.
delete_time	Integer	Deletion timestamp.
description	String	Description.
directory	String	Directory path.
owner_type	String	Owner type, for example, USER.
pipe_alias	String	Pipeline alias.
pipe_id	String	Pipeline ID.
pipe_name	String	Pipeline name.
process_error	String	Processing error status, for example, NONE.
process_status	String	Processing status, for example, COMPLETED.
project_id	String	Project ID.
resources	Array of IsapResource objects	Resource list.
schema	Schema object	Format.
storage_setting	StorageSetting object	Storage settings.
update_by	String	Updater information.
update_time	Long	Update timestamp.
workspace_id	String	Workspace ID.

**Table 4** IsapResource
Parameter	Type	Description
category	String	Resource type, for example, STREAMING or INDEX.
create_by	String	Creator information.
create_time	Integer	Creation timestamp.
data_classification	String	Data classification, for example, FACTUAL_DATA.
data_layering	String	Data layers, for example, ODS.
delete_time	Integer	Deletion timestamp.
description	String	Description.
directory	String	Directory path.
display_setting	display_setting object	Display settings.
format	String	Data format, for example, JSON.
lock_status	String	Lock status, for example, UNLOCKED.
owner_type	String	Owner type, for example, USER.
pipe_id	String	Pipeline ID.
process_error	String	Processing error status, for example, NONE.
process_status	String	Processing status, for example, COMPLETED.
project_id	String	Project ID.
rw_type	String	Read/Write type, for example, READ_WRITE.
schema	Schema object	Format.
storage_setting	StorageSetting object	Storage settings.
store_size_in_bytes	Integer	Storage size (in byte).
table_alias	String	Table alias.
table_id	String	Table ID.
table_name	String	Table name.
update_by	String	Updater information.
update_time	Integer	Update timestamp.
workspace_id	String	Workspace ID.

**Table 5** display_setting
Parameter	Type	Description
columns	Array of columns objects	Column.
format	String	Display format, for example, TABLE.

**Table 6** columns
Parameter	Type	Description
column_alias	String	Column alias.
column_name	String	Column name.
display_by_default	Boolean	Whether to display by default.

**Table 7** Schema
Parameter	Type	Description
columns	Array of columns objects	Column.
partition	Array of strings	Partition.
primary_key	Array of strings	Primary key.
time_filter	String	Time filter column.
watermark_column	String	Watermark column.
watermark_interval	Number	Watermark spacing.

**Table 8** columns
Parameter	Type	Description
array	Boolean	Array or not.
column_data_type	String	Column data type, for example, TIMESTAMP or INT.
column_data_type_setting	String	Data type settings.
column_name	String	Column name.
column_sequence_number	Integer	Column No.
column_type	String	Column type, for example, PHYSICAL.
column_type_setting	String	Column type settings.
depth	Integer	Depth.
nullable	Boolean	Whether the value can be empty.
own_name	String	In-house name.
parent_name	String	Parent name.

**Table 9** StorageSetting
Parameter	Type	Description
data_transformation_cu	Number	Data conversion CU.
index_replicas	Integer	Number of index replicas.
index_shards	Integer	Number of index shards.
index_storage_period	Integer	Index storage period.
index_storage_size	Integer	Index storage size.
lake_storage_period	Integer	Lake storage period.
streaming_bandwidth	Number	Streaming bandwidth.
streaming_dataspace_id	String	Streaming data space ID.
streaming_partition	Integer	Number of streaming partitions.
streaming_retention_size	Integer	Reserved stream size.
streaming_retention_time	Integer	Reserved stream time.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

None

Example Responses

Status code: 200

Successful.

{
  "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 Sample Code

The SDK sample code is as follows.

      
       
         
         
           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("<YOUR REGION>"))
                .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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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("<YOUR REGION>")) \
        .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)

          

        

      
     

      
       
         
         
           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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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)
    }
}

          

        

      
     