更新时间:2026-01-29 GMT+08:00
分享

获取管道列表 - ListPipes

功能介绍

获取管道列表

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/pipes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

参数解释:

偏移量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

Long

参数解释:

查询数据限制

取值范围:

0-1000

默认取值:

不涉及

sort_key

String

按照属性排序。

sort_dir

String

排序顺序,支持 ASCDESC

pipe_name_in_query

String

管道名称

pipe_id_in_query

String

管道ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

计数

records

Array of PipeItem objects

管道记录

表5 PipeItem

参数

参数类型

描述

project_id

String

项目ID

workspace_id

String

UUID

pipe_id

String

UUID

pipe_name

String

管道名称

pipe_alias

String

管道别名

category

String

参数解释:

管道目录

  • STREAMING_TO_INDEX 流式写入索引

  • STREAMING_TO_LAKE 流式写入数据湖

  • STREAMING_TO_INDEX_LAKE 流式写入索引和数据湖

  • STREAMING 流式传输中

约束限制

不涉及

取值范围:

  • STREAMING_TO_INDEX

  • STREAMING_TO_LAKE

  • STREAMING_TO_INDEX_LAKE

  • STREAMING

默认值

不涉及

directory

String

directory 目录分组

description

String

管道描述

process_status

String

参数解释:

作业处理状态

  • COMPLETED 已完成

  • CREATING 创建中

  • UPDATING 更新中

  • DELETING 删除中

  • UPDATING_FAILED 更新失败

  • DELETING_FAILED 删除失败

约束限制

不涉及

取值范围:

  • COMPLETED

  • CREATING

  • UPDATING

  • DELETING

  • UPDATING_FAILED

  • DELETING_FAILED

默认值

不涉及

process_error

String

参数解释:

管道处理错误

  • NONE 无

约束限制

不涉及

取值范围:

  • NONE

默认值

不涉及

owner_type

String

参数解释:

管道所有者类型

  • SYSTEM 系统

  • USER 用户

  • CLOUD_LOG 云日志

约束限制

不涉及

取值范围:

  • SYSTEM

  • USER

  • CLOUD_LOG

默认值

不涉及

create_time

Integer

毫秒时间戳

update_time

Integer

毫秒时间戳

delete_time

Integer

毫秒时间戳

请求示例

响应示例

状态码:200

成功

{
  "count" : 1,
  "records" : [ {
    "category" : "STREAMING_TO_INDEX",
    "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",
    "update_time" : 1768383768886,
    "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155"
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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 ListPipesSolution {

    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();
        ListPipesRequest request = new ListPipesRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ListPipesResponse response = client.listPipes(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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 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"]
    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 = ListPipesRequest()
        request.workspace_id = "{workspace_id}"
        response = client.list_pipes(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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")
    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.ListPipesRequest{}
	request.WorkspaceId = "{workspace_id}"
	response, err := client.ListPipes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档