创建外部推送通道

project_id

是

String

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

最小长度：1

最大长度：64

X-Auth-Token

是

String

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

最小长度：0

最大长度：20000

channel_id

否

String

推送通道ID,非必填，若用户不填，则系统自动生成

最小长度：1

最大长度：64

channel

是

String

通道

name

是

String

推送通道名称

最小长度：1

最大长度：64

description

否

String

推送通道描述

最小长度：0

最大长度：255

endpoint

是

String

推送的地址

最小长度：1

最大长度：256

mqtt_channel_detail

否

CreateMqttChannelDetail object

MQTT通道配置详情

iotdb_channel_detail

否

CreateIoTDBChannelDetail object

MQTT通道配置详情

influxdb2_channel_detail

否

CreateInfluxDB2ChannelDetail object

MQTT通道配置详情

pulsar_channel_detail

否

CreatePulsarChannelDetail object

Pulsar通道配置详情

connection_info

是

MqttConnectionInfo object

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

push_info

是

MqttPushInfo object

创建MQTT推送信息

username

是

String

鉴权用户名

最小长度：1

最大长度：128

password

是

String

鉴权密码

最小长度：8

最大长度：128

trust_certs

否

Object

客户端信任证书列表

数组长度：0 - 5

verify_hostname

否

Boolean

客户端是否开启校验域名

缺省值：true

device_data

否

DeviceMqttPushInfo object

创建设备数据推送MQTT

topic

是

String

client推送的topic

最小长度：1

最大长度：256

format

否

String

数据格式转换类型

缺省值：iotda_1.0

最小长度：1

最大长度：32

qos

否

Integer

Mqtt的服务质量

最小值：0

最大值：2

缺省值：0

connection_info

是

IoTDBConnectionInfo object

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

push_info

是

IoTDBPushInfo object

创建IoTDB推送信息

username

是

String

鉴权用户名

最小长度：1

最大长度：128

password

是

String

鉴权密码

最小长度：8

最大长度：128

device_data

否

DeviceIoTDBPushInfo object

创建设备数据推送IoTDB

storage_group

是

String

数据存储的存储组

最小长度：1

最大长度：32

format

是

String

数据格式转换类型

缺省值：iotda_1.0

最小长度：1

最大长度：32

connection_info

是

InfluxDB2ConnectionInfo object

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

push_info

是

InfluxDB2PushInfo object

创建IoTDB推送信息

token

是

String

鉴权token

最小长度：1

最大长度：128

trust_certs

否

Object

客户端信任证书列表

数组长度：0 - 5

verify_hostname

否

Boolean

客户端是否开启校验域名

缺省值：true

device_data

否

DeviceInfluxDB2PushInfo object

创建设备数据推送MQTT

organization

是

String

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

最小长度：1

最大长度：32

bucket

是

String

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

最小长度：1

最大长度：32

format

是

String

数据格式转换类型

缺省值：iotda_1.0

最小长度：1

最大长度：32

connection_info

是

PulsarConnectionInfo object

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

push_info

是

PulsarPushInfo object

创建Pulsar推送信息

token

是

String

鉴权token

最小长度：1

最大长度：128

device_data

否

DevicePulsarPushInfo object

创建设备数据推送Pulsar

topic

是

String

client推送的topic

最小长度：1

最大长度：256

channel_id

String

推送通道ID

name

String

推送通道名称

channel

String

通道

description

String

推送通道描述

endpoint

String

推送的地址

mqtt_channel_detail

MqttChannelDetailDTO object

MQTT通道详情

iotdb_channel_detail

IoTDBChannelDetailDTO object

IoTDB通道详情

influxdb2_channel_detail

CreateInfluxDB2ChannelDetail object

MQTT通道配置详情

pulsar_channel_detail

PulsarChannelDetailDTO object

Pulsar通道详情

create_time

String

创建时间

update_time

String

更新时间

connection_info

MqttConnectionInfoResp object

外部推送通道返回详情

push_info

MqttPushInfoResp object

MQTT推送信息详情

username

String

鉴权用户名

trust_certs

Object

客户端信任证书列表

verify_hostname

Boolean

客户端是否开启校验域名

device_data

DeviceMqttPushInfoDetail object

设备数据推送MQTT详情

topic

String

client推送的topic

最小长度：1

最大长度：256

format

String

数据格式转换类型

最小长度：1

最大长度：32

qos

Integer

MQTT的服务质量

最小值：0

最大值：2

connection_info

IoTDBConnectionInfoResp object

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

push_info

IoTDBPushInfoResp object

IoTDB推送信息详情

username

String

鉴权用户名

password

String

鉴权密码

device_data

DeviceIoTDBPushInfoDetail object

创建设备数据推送IoTDB

storage_group

String

数据存储的存储组

最小长度：1

最大长度：32

format

String

数据格式转换类型

最小长度：1

最大长度：32

connection_info

InfluxDB2ConnectionInfo object

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

push_info

InfluxDB2PushInfo object

创建IoTDB推送信息

token

String

鉴权token

最小长度：1

最大长度：128

trust_certs

Object

客户端信任证书列表

数组长度：0 - 5

verify_hostname

Boolean

客户端是否开启校验域名

缺省值：true

device_data

DeviceInfluxDB2PushInfo object

创建设备数据推送MQTT

organization

String

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

最小长度：1

最大长度：32

bucket

String

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

最小长度：1

最大长度：32

format

String

数据格式转换类型

缺省值：iotda_1.0

最小长度：1

最大长度：32

connection_info

PulsarConnectionInfoResp object

外部推送通道返回详情

push_info

PulsarPushInfoResp object

Pulsar推送信息详情

token

String

鉴权token

最小长度：1

最大长度：128

device_data

DevicePulsarPushInfoDetail object

设备数据推送Pulsar详情

topic

String

client推送的topic

最小长度：1

最大长度：256

201

Created

400

BAD REQUEST

500

Internal Server Error