文档首页/ 应用与数据集成平台 ROMA Connect/ API参考（阿布扎比区域）/ 设备集成API/ 设备分组管理/ 创建设备分组
更新时间：2022-12-05 GMT+08:00
查看PDF
分享

创建设备分组

功能介绍

创建设备分组

URI

POST /v2/{project_id}/link/instances/{instance_id}/device-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度：0

最大长度：32

instance_id

是

String

实例ID

最小长度：0

最大长度：36

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

parent_id

是

Integer

父分组ID，自动向下取整

最小值：0

最大值：99999999999999999

name

是

String

分组名称，支持中文，英文大小写，数字，下划线和中划线,长度2-64

最小长度：2

最大长度：64

description

否

String

分组描述

最小长度：0

最大长度：200

app_id

是

String

分组归属应用ID

最小长度：0

最大长度：36

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

permissions

Array of strings

权限

parent_id

Integer

父分组ID

最小值：1

最大值：99999999999999999

id

Integer

分组ID

最小值：1

最大值：99999999999999999

name

String

分组名称，支持中文，英文大小写，数字，下划线和中划线,长度2-64

最小长度：2

最大长度：64

description

String

分组描述，长度0-200

最小长度：0

最大长度：200

app_id

String

分组归属应用ID

最小长度：0

最大长度：36

created_user

CreatedUser object

创建时的用户

last_updated_user

LastUpdatedUser object

最后更新时的用户

created_datetime

String

创建时间

最小长度：0

最大长度：50

last_updated_datetime

String

最后修改时间

最小长度：0

最大长度：50

app_name

String

应用名称

最小长度：0

最大长度：50
表4 CreatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度：0

最大长度：64

user_name

String

用户名

最小长度：0

最大长度：64
表5 LastUpdatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度：0

最大长度：64

user_name

String

用户名

最小长度：0

最大长度：64

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

请求示例

{
  "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",
  "app_name" : "app-link"
}

状态码： 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].",
  "requestId" : "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.",
  "requestId" : "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

错误码

请参见错误码。

父主题： 设备分组管理