IoT边缘 IoTEdge-在指定节点上创建外部实体:请求参数
下载IoT边缘 IoTEdge用户手册完整版
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
external_id |
是 |
String |
外部实体Id，节点下唯一 最小长度：1 最大长度：64 |
|
protocol |
是 |
String |
连接外部实体的协议类型 |
|
connection_type |
是 |
String |
连接类型 |
|
mqtt_connection_info |
否 |
MqttConnectionInfo object |
mqtt连接信息 |
|
space_id |
否 |
String |
资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下，否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. 最小长度：1 最大长度：36 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
server_address |
否 |
String |
采用cleint方式连接时，mqtt服务器地址 最小长度：4 最大长度：128 |
|
client_id |
否 |
String |
mqtt连接时，client_id 最小长度：4 最大长度：256 |
|
auth_type |
否 |
String |
鉴权类型。支持密钥认证接入(SECRET)和证书认证接入(CERTIFICATES)两种方式。使用密钥认证接入方式(SECRET)填写user_name和user_name字段，使用证书认证接入方式(CERTIFICATES)填写privateKey和certificate字段 |
|
private_key |
否 |
String |
证书密钥 最小长度：4 最大长度：20000 |
|
certificate |
否 |
String |
证书 最小长度：4 最大长度：20000 |
|
user_name |
否 |
String |
用户名 最小长度：4 最大长度：256 |
|
password |
否 |
String |
密码 最小长度：4 最大长度：256 |
|
qos |
否 |
Integer |
服务质量,默认为0,表示最多一次的传输,1表示至少一次,2表示仅一次. 缺省值：0 最小长度：1 最大长度：1 |
