更新时间:2026-02-05 GMT+08:00
分享

投递规则详情 - ShowShipper

功能介绍

投递规则详情

调用方法

请参见如何调用API

授权信息

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

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/shippers/{shipper_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

shipper_id

String

投递ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

code

Integer

状态码

data

data object

投递数据

msg

String

响应消息

表4 data

参数

参数类型

描述

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

shipper_destination object

投递目的

shipper_id

String

投递ID

shipper_name

String

投递名称

shipper_source

shipper_source object

投递源

status

Integer

状态

update_time

Long

更新时间(时间戳)

version

String

版本

workspace_id

String

工作空间ID

workspace_name

String

工作空间名称

表5 shipper_destination

参数

参数类型

描述

data_param

String

目的参数

data_type

Integer

数据类型

dataspace

String

数据空间

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

工作空间名称

表6 shipper_source

参数

参数类型

描述

data_type

Integer

数据类型

dataspace

String

数据空间

dataspace_name

String

数据空间名称

id

Integer

源ID

identity

String

标识

pipe

String

管道ID

pipe_name

String

管道名称

region

String

区域

type

Integer

类型

workspace

String

工作空间ID

workspace_name

String

工作空间名称

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询投递详情

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/siem/shippers/{shipper_id}

响应示例

状态码:200

成功

{
  "code" : 0,
  "data" : {
    "consumption_type" : 0,
    "create_time" : 1758006480427,
    "domain_id" : "f9d7bacbfd2c49e892532ba3f62ab75d",
    "id" : 1297,
    "project_id" : "f69081793d9e4ea8a2f479dcef961989",
    "shipper_destination" : {
      "data_param" : "{\"group_id\":\"83e8f406-0479-4d6a-8b4a-f782df6def3c\",\"group_name\":\"lts-group-test\",\"stream_id\":\"7d8aba20-0c9c-449e-8e42-2d8e2bd082d0\",\"stream_name\":\"lts-topic-test\"}",
      "data_type" : 3,
      "destination_info" : "lts-group-test/lts-topic-test",
      "id" : 2596,
      "identity" : "lts-strategy",
      "region" : "test_region",
      "type" : 1
    },
    "shipper_id" : "e46287fc-f919-4db9-b795-9837d6dfc256",
    "shipper_name" : "eeeee",
    "shipper_source" : {
      "data_type" : 0,
      "id" : 2595,
      "identity" : "lts-strategy",
      "region" : "test_region",
      "type" : 0,
      "workspace" : "f44065f5-557b-4376-ae02-8c65ef1960f4",
      "workspace_name" : "test_workspace"
    },
    "status" : 0,
    "update_time" : 1767940257585,
    "version" : "v2",
    "workspace_id" : "f44065f5-557b-4376-ae02-8c65ef1960f4",
    "workspace_name" : "test_workspace"
  },
  "msg" : "success"
}

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
49
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 ShowShipperSolution {

    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();
        ShowShipperRequest request = new ShowShipperRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withShipperId("{shipper_id}");
        try {
            ShowShipperResponse response = client.showShipper(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
33
# 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 = ShowShipperRequest()
        request.workspace_id = "{workspace_id}"
        request.shipper_id = "{shipper_id}"
        response = client.show_shipper(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
39
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.ShowShipperRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.ShipperId = "{shipper_id}"
	response, err := client.ShowShipper(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功

400

错误响应

错误码

请参见错误码

相关文档