文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 客户端节点管理/ 修改已分配节点通道的详情
更新时间:2024-06-20 GMT+08:00
分享

修改已分配节点通道的详情

功能介绍

修改已分配节点通道的详情

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/push-channels/{channel_id}/client-nodes/{node_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见 获取项目ID

最小长度:1

最大长度:64

channel_id

String

边缘推送通道ID

最小长度:1

最大长度:64

node_id

String

边缘节点ID

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

最小长度:0

最大长度:20000

表3 请求Body参数

参数

是否必选

参数类型

描述

mqtt_channel_detail

UpdateMqttNodeChannelDetail object

更新MQTT推送通道详情请求结构体

pulsar_channel_detail

UpdatePulsarNodeChannelDetail object

更新Pulsar推送通道详情请求结构体

表4 UpdateMqttNodeChannelDetail

参数

是否必选

参数类型

描述

connection_info

UpdateMqttNodeChannelConnectionInfo object

更新外部推送通道请求结构体

push_info

UpdateMqttNodeChannelPushInfoDTO object

MQTT推送信息详情

表5 UpdateMqttNodeChannelConnectionInfo

参数

是否必选

参数类型

描述

client_id

String

mqtt协议中的ClientId

最小长度:1

最大长度:256

username

String

鉴权用户名

最小长度:1

最大长度:128

password

String

鉴权密码

最小长度:8

最大长度:164

trust_certs

Object

客户端信任证书列表

数组长度:0 - 5

verify_hostname

Boolean

客户端是否开启校验域名

表6 UpdateMqttNodeChannelPushInfoDTO

参数

是否必选

参数类型

描述

device_data

DeviceMqttNodeChannelPushInfoDetail object

设备数据推送MQTT详情

表7 DeviceMqttNodeChannelPushInfoDetail

参数

是否必选

参数类型

描述

topic

String

client推送的topic

最小长度:1

最大长度:256

qos

Integer

Mqtt的服务质量

最小值:0

最大值:2

表8 UpdatePulsarNodeChannelDetail

参数

是否必选

参数类型

描述

connection_info

UpdatePulsarNodeChannelConnectionInfo object

更新外部推送通道请求结构体

push_info

UpdatePulsarNodeChannelPushInfoDTO object

Pulsar推送信息详情

表9 UpdatePulsarNodeChannelConnectionInfo

参数

是否必选

参数类型

描述

token

String

鉴权token

最小长度:1

最大长度:128

表10 UpdatePulsarNodeChannelPushInfoDTO

参数

是否必选

参数类型

描述

device_data

DevicePulsarNodeChannelPushInfoDetail object

设备数据推送Pulsar详情

表11 DevicePulsarNodeChannelPushInfoDetail

参数

是否必选

参数类型

描述

topic

String

client推送的topic

最小长度:1

最大长度:256

响应参数

状态码: 200

表12 响应Body参数

参数

参数类型

描述

channel

String

通道

description

String

推送通道描述

endpoint

String

推送的地址

mqtt_channel_detail

MqttNodeChannelDetailDTO object

MQTT通道详情

iotdb_channel_detail

IoTDBNodeChannelDetailDTO object

IoTDB通道详情

influxdb2_channel_detail

InfluxDB2NodeChannelDetailDTO object

MQTT通道配置详情

pulsar_channel_detail

PulsarNodeChannelDetailDTO object

Pulsar通道详情

create_time

String

创建时间

update_time

String

更新时间

synchronized_time

String

下发时间,表示通道是否已经同步到了节点

synchronized_status

Boolean

下发状态,表示是否已同步到了节点

表13 MqttNodeChannelDetailDTO

参数

参数类型

描述

connection_info

MqttNodeChannelConnectionInfoResp object

外部推送通道返回详情

push_info

MqttNodeChannelPushInfoRsp object

MQTT推送信息详情

表14 MqttNodeChannelConnectionInfoResp

参数

参数类型

描述

client_id

String

mqtt协议中的ClientId

username

String

鉴权用户名

trust_certs

Object

客户端信任证书列表

verify_hostname

Boolean

客户端是否开启校验域名

表15 MqttNodeChannelPushInfoRsp

参数

参数类型

描述

device_data

DeviceMqttNodeChannelPushInfoDetail object

设备数据推送MQTT详情

表16 DeviceMqttNodeChannelPushInfoDetail

参数

参数类型

描述

topic

String

client推送的topic

最小长度:1

最大长度:256

qos

Integer

Mqtt的服务质量

最小值:0

最大值:2

表17 IoTDBNodeChannelDetailDTO

参数

参数类型

描述

connection_info

IoTDBConnectionInfoResp object

创建外部推送通道请求结构体

push_info

IoTDBNodeChannelPushInfoResp object

IoTDB推送信息详情

表18 IoTDBConnectionInfoResp

参数

参数类型

描述

username

String

鉴权用户名

password

String

鉴权密码

表19 IoTDBNodeChannelPushInfoResp

参数

参数类型

描述

device_data

DeviceIoTDBNodeChannelPushInfoDetail object

创建设备数据推送IoTDB

表20 DeviceIoTDBNodeChannelPushInfoDetail

参数

参数类型

描述

storage_group

String

数据存储的存储组

最小长度:1

最大长度:32

表21 InfluxDB2NodeChannelDetailDTO

参数

参数类型

描述

connection_info

InfluxDB2ConnectionInfo object

创建外部推送通道请求结构体

push_info

InfluxDB2NodeChannelPushInfoRsp object

创建IoTDB推送信息

表22 InfluxDB2ConnectionInfo

参数

参数类型

描述

token

String

鉴权token

最小长度:1

最大长度:128

trust_certs

Object

客户端信任证书列表

数组长度:0 - 5

verify_hostname

Boolean

客户端是否开启校验域名

缺省值:true

表23 InfluxDB2NodeChannelPushInfoRsp

参数

参数类型

描述

device_data

DeviceInfluxDB2NodeChannelPushInfoDetail object

创建设备数据推送InfluxDB2

表24 DeviceInfluxDB2NodeChannelPushInfoDetail

参数

参数类型

描述

organization

String

一组用户的工作空间,一组用户下可以创建多个bucket

最小长度:1

最大长度:32

bucket

String

数据存储的地方,结合了数据库和存储周期的概念

最小长度:1

最大长度:32

表25 PulsarNodeChannelDetailDTO

参数

参数类型

描述

connection_info

PulsarNodeChannelConnectionInfoResp object

外部推送通道返回详情

push_info

PulsarNodeChannelPushInfoRsp object

Pulsar推送信息详情

表26 PulsarNodeChannelConnectionInfoResp

参数

参数类型

描述

token

String

鉴权token

最小长度:1

最大长度:128

表27 PulsarNodeChannelPushInfoRsp

参数

参数类型

描述

device_data

DevicePulsarNodeChannelPushInfoDetail object

设备数据推送Pulsar详情

表28 DevicePulsarNodeChannelPushInfoDetail

参数

参数类型

描述

topic

String

client推送的topic

最小长度:1

最大长度:256

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Not Found

401

Unauthorized

500

Internal Server Error

错误码

请参见错误码

相关文档