设备接入 IOTDA-创建设备策略:请求参数

时间:2024-06-28 09:24:33

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情

表3 请求Body参数

参数

是否必选

参数类型

描述

policy_name

String

参数说明:策略名称。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。

app_id

String

参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数指定创建的设备归属到哪个资源空间下,否则创建的设备将会归属到默认资源空间下。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

statement

Array of Statement objects

参数说明:策略文档。

表4 Statement

参数

是否必选

参数类型

描述

effect

String

指定是允许还是拒绝该操作。既有允许(ALLOW)又有拒绝(DENY)的授权语句时,遵循拒绝(DENY)优先的原则。

  • ALLOW:允许。

  • DENY:拒绝。

actions

Array of strings

用于指定策略允许或拒绝的操作。格式为:服务名:资源:操作。当前支持的操作类型如下:

  • iotda:devices:publish:设备使用MQTT协议发布消息。

  • iotda:devices:subscribe:设备使用MQTT协议订阅消息。

resources

Array of strings

用于指定允许或拒绝对其执行操作的资源。格式为:资源类型:资源名称。如设备订阅的资源为:topic:/v1/${devices.deviceId}/test/hello。

取值范围:资源列表长度最小为1,最大为10,列表中的资源取值范围:仅支持字母,数字,以及/{}$=+#?*:._-组合。

support.huaweicloud.com/api-iothub/CreateDevicePolicy.html