链接复制成功！
创建设备分组
功能介绍
创建设备分组。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/link/instances/{instance_id}/device-groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。兼容20.0场景默认为default。项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
|
instance_id |
是 |
String |
实例的ID。兼容20.0场景默认为default。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
parent_id |
是 |
Integer |
父分组ID，自动向下取整。 |
|
name |
是 |
String |
分组名称，支持中文，英文大小写，数字，下划线和中划线，长度2-64。 |
|
description |
否 |
String |
分组描述。 |
|
app_id |
是 |
String |
分组归属应用ID。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
permissions |
Array of strings |
权限。 |
|
parent_id |
Integer |
父分组ID。 |
|
id |
Integer |
分组ID。 |
|
name |
String |
分组名称，支持中文、英文大小写、数字、下划线和中划线，长度2-64。 |
|
description |
String |
分组描述，长度0-200。 |
|
app_id |
String |
分组归属应用ID。 |
|
created_user |
CreatedUser object |
创建时的用户。 |
|
last_updated_user |
LastUpdatedUser object |
最后更新时的用户。 |
|
created_datetime |
String |
创建时间。 |
|
last_updated_datetime |
String |
最后修改时间。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
|
error_msg |
String |
错误描述。 |
|
request_id |
String |
消息ID。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
|
error_msg |
String |
错误描述。 |
|
request_id |
String |
消息ID。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
|
error_msg |
String |
错误描述。 |
|
request_id |
String |
消息ID。 |
请求示例
在指定父分组下创建一个设备分组。
{
"parent_id" : 10001,
"name" : "device_group",
"description" : "device group",
"app_id" : "ef3845be-091a-4ab5-869a-9de0025e2165"
}响应示例
状态码： 200
Created
{
"permissions" : [ "read", "access", "delete", "modify" ],
"parent_id" : 0,
"id" : 1,
"name" : "group1",
"description" : "group",
"app_id" : "fe382523-cf76-4152-9fc6-f772d4427302",
"created_user" : {
"user_id" : "6546435432432",
"user_name" : "user1"
},
"last_updated_user" : {
"user_id" : "6546435432432",
"user_name" : "user1"
},
"created_datetime" : "2020-12-11",
"last_updated_datetime" : "2020-12-11"
}状态码： 400
Bad Request
{
"error_code" : "SCB.00000000",
"error_msg" : "Parameter is not valid for operation [romalink.link-device-groups.save]. Parameter is [request]. Processor is [body].",
"request_id" : "4946aac3-6f8f-46b8-8b06-513f4084196c-1619602488278-cnnorth7a-P-romalink-service01"
}状态码： 404
Not Found
{
"error_code" : "ROMA.00110006",
"error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.",
"request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}状态码： 500
Internal Server Error
{
"error_code" : "ROMA.00110002",
"error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
"request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Created |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
