更新时间:2024-07-22 GMT+08:00

创建数据管道

功能介绍

创建数据管道

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/siem/pipes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id

最小长度:32

最大长度:36

workspace_id

String

工作空间id

最小长度:32

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:2097152

表3 请求Body参数

参数

是否必选

参数类型

描述

dataspace_id

String

工作空间ID

最小长度:36

最大长度:36

pipe_name

String

数据管道名称

最小长度:5

最大长度:63

description

String

描述

最小长度:1

最大长度:255

storage_period

Integer

数据的保存时间,单位为天;默认30天,取值范围为1~3600

最小值:1

最大值:3600

shards

Integer

数据管道分区个数;默认创建1个,最大支持创建64个分区

最小值:1

最大值:64

timestamp_field

String

时间戳字段

缺省值:__time

最小长度:1

最大长度:256

mapping

Map<String,KeyIndex>

索引字段映射;每个key对象承载一个字段的信息;存在多个key对象,key可变,表示字段名称;可嵌套

表4 KeyIndex

参数

是否必选

参数类型

描述

type

String

字段类型;text 全文索引字段、keyword 结构化字段、long Long、integer Integer、double Double、float Float、date 时间字段

枚举值:

  • text

  • keyword

  • long

  • integer

  • double

  • float

  • date

is_chinese_exist

Boolean

是否包含中文

properties

Map<String,KeyIndex>

嵌套结构

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

domain_id

String

用户domainId

最小长度:32

最大长度:36

project_id

String

项目id

最小长度:32

最大长度:36

dataspace_id

String

数据空间id

最小长度:32

最大长度:36

dataspace_name

String

数据空间名称

最小长度:32

最大长度:36

pipe_id

String

管道id

最小长度:32

最大长度:36

pipe_name

String

管道名称

最小长度:32

最大长度:36

pipe_type

String

管道类型(system-defined,系统预定义)、1(user-defined,用户自定义)

最小长度:5

最大长度:128

description

String

描述信息

最小长度:5

最大长度:128

storage_period

Integer

索引存储天数

最小值:1

最大值:100000

shards

Integer

索引分片数量

最小值:1

最大值:128

create_by

String

创建者

最小长度:5

最大长度:128

create_time

Integer

创建时间

最小值:0

最大值:1010000000

update_by

String

更新者

最小长度:5

最大长度:128

update_time

Integer

更新时间

最小值:0

最大值:10000000000

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

无效请求提示信息

最小长度:1

最大长度:128

error_code

String

错误码

最小长度:1

最大长度:128

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_msg

String

权限错误

最小长度:1

最大长度:128

error_code

String

错误码

最小长度:1

最大长度:128

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

系统内部错误

最小长度:1

最大长度:128

error_code

String

错误码

最小长度:1

最大长度:128

请求示例

{
  "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
  "pipe_name" : "pipe-01",
  "description" : "test pipe",
  "storage_period" : 30,
  "shards" : 3,
  "mapping" : {
    "name" : {
      "type" : "text"
    },
    "id" : {
      "type" : "text"
    },
    "publish_time" : {
      "type" : "data"
    }
  }
}

响应示例

状态码: 200

创建成功返回值

{
  "domain_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx",
  "project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
  "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
  "dataspace_name" : "dataspace-01",
  "pipe_id" : "b22106ba-bede-453c-8488-b60c70bd6aed",
  "pipe_name" : "pipe-01",
  "pipe_type" : "system-defined",
  "description" : "test pipe",
  "storage_period" : 30,
  "shards" : 3,
  "create_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx",
  "create_time" : 1584883694354,
  "update_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx",
  "update_time" : 1584883694354
}

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
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 CreatePipeSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        CreatePipeRequest request = new CreatePipeRequest();
        CreatePipeRequestBody body = new CreatePipeRequestBody();
        request.withBody(body);
        try {
            CreatePipeResponse response = client.createPipe(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"]

    credentials = BasicCredentials(ak, sk)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreatePipeRequest()
        request.body = CreatePipeRequestBody(
        )
        response = client.create_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)
 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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

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

    request := &model.CreatePipeRequest{}
	request.Body = &model.CreatePipeRequestBody{
	}
	response, err := client.CreatePipe(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

创建成功返回值

400

错误请求

401

认证失败

403

禁止访问

500

系统内部错误

错误码

请参见错误码