文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 租户采集/ 更新采集连接 - UpdateCollectorConnection
更新时间:2026-01-29 GMT+08:00
分享

更新采集连接 - UpdateCollectorConnection

功能介绍

更新采集连接

调用方法

请参见如何调用API

授权信息

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

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/collector/connections/{connection_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

connection_id

String

连接 ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

description

String

描述信息

fields

Array of ConnectionModuleFieldUpdateVo objects

相关描述信息

module_id

String

UUID

name

String

所属租户名称

template_id

String

UUID

title

String

相关标题

表4 ConnectionModuleFieldUpdateVo

参数

是否必选

参数类型

描述

field_id

String

UUID

name

String

所属租户名称

template_field_id

String

UUID

title

String

相关标题

type

String

value的数据类型

value

String

相关值

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

connection_id

String

UUID

请求示例

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/collector/connections/{connection_id}

{
  "name" : "tcp",
  "template_id" : "d51164ad-40a4-4b26-9b9d-d454da34adec",
  "title" : "myudp",
  "description" : "myudp",
  "fields" : [ {
    "name" : "mode",
    "template_field_id" : "926867ed-e31f-4766-911b-bad57f0c436a",
    "title" : "Mode",
    "type" : "string",
    "value" : "server",
    "field_id" : "b73cfca4-cefd-461d-8d2a-cc41da69a351"
  }, {
    "name" : "port",
    "template_field_id" : "a784d1d7-e049-4602-a7a8-c8cc1bff8c65",
    "title" : "Port",
    "type" : "number",
    "value" : 514,
    "field_id" : "15647df2-5a51-4038-80b1-f810d3f67c52"
  }, {
    "name" : "codec",
    "template_field_id" : "4d839ce2-485c-4a93-b778-fd02b6ad308e",
    "title" : "Codec",
    "type" : "string",
    "value" : "plain",
    "field_id" : "f00397cf-e900-4460-86f3-215b0722488a"
  } ],
  "module_id" : "8354620a-0502-4710-8d2d-3d20b0454df0"
}

响应示例

状态码:200

成功

{
  "connection_id" : "c46a23d5-5c16-4314-8ac9-0e89050c13ff"
}

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

    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();
        UpdateCollectorConnectionRequest request = new UpdateCollectorConnectionRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withConnectionId("{connection_id}");
        try {
            UpdateCollectorConnectionResponse response = client.updateCollectorConnection(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 = UpdateCollectorConnectionRequest()
        request.workspace_id = "{workspace_id}"
        request.connection_id = "{connection_id}"
        response = client.update_collector_connection(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.UpdateCollectorConnectionRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.ConnectionId = "{connection_id}"
	response, err := client.UpdateCollectorConnection(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档