创建注册组
功能介绍
应用服务器可调用此接口在物联网平台创建一个注册组。
URI
POST /v5/iotps/{project_id}/registration-groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id。 最小长度:1 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
registration_group_name |
是 |
String |
注册组名称。 最小长度:1 最大长度:256 |
provision_info |
是 |
AddProvisionInfo object |
新增设备组,设备的发放信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
allocation_strategy_type |
是 |
String |
策略类型。目前支持静态策略(base),证书策略(certificates)和自定义策略(functions) 缺省值:functions |
certificate_id |
否 |
String |
证书id。使用第三方上传CA,证书ID为设备发放服务生成的证书id,使用云证书CA,证书ID为云证书服务生成的证书ID。 最小长度:0 最大长度:256 |
func_urn |
否 |
String |
函数的URN(Uniform Resource Name),唯一标识函数。 最小长度:1 最大长度:360 |
auth_type |
否 |
String |
认证类型 |
register_group_secret |
否 |
String |
设备组密钥,设置该字段时平台将设备密钥置为指定值,若不设置则由平台自动生成。 最小长度:44 最大长度:172 |
init_config |
否 |
String |
注册组的初始化配置。必须为json字符串 最小长度:1 最大长度:65535 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
registration_group_id |
String |
注册组id 最小长度:0 最大长度:256 |
register_group_secret |
String |
设备组密钥,设置该字段时平台将设备密钥置为指定值,若不设置则由平台自动生成。 最小长度:44 最大长度:172 |
请求示例
{ "registration_group_name" : "test_group", "provision_info" : { "auth_type" : "SECRET", "register_group_secret" : "faertyhb5rthjk_3bnr224-vjbdsrhfjuASF", "allocation_strategy_type" : "base", "init_config" : "{\"properties\": \"khfkfj\"}" } }
响应示例
状态码: 200
OK
{ "registration_group_id" : "523412", "register_group_secret" : "3b935a250c50dc2c6d48-1d04hjgadf_8cefdc3c" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。