文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 设备集成API/ 设备分组管理/ 修改设备分组 - UpdateDeviceGroup
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改设备分组 - UpdateDeviceGroup

功能介绍

修改设备分组。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v2/{project_id}/link/instances/{instance_id}/device-groups/{group_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。兼容20.0场景默认为default。项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例的ID。兼容20.0场景默认为default。

group_id

是

Integer

设备分组ID，该字段为数据库中的自增唯一标识符；通过调用查询所有设备分组接口：GET /v2/{project_id}/link/instances/{instance_id}/device-groups获取响应体中对应设备分组的id字段值。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

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

description

否

String

分组描述，长度0-200。

attrs

否

Object

分组级配置参数

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

permissions

Array of strings

权限。

parent_id

Integer

父分组ID。通过调用查询所有设备分组接口：GET /v2/{project_id}/link/instances/{instance_id}/device-groups获取响应体中对应设备分组的parent_id字段值。

id

Integer

设备分组ID，该字段为数据库中的自增唯一标识符；通过调用查询所有设备分组接口：GET /v2/{project_id}/link/instances/{instance_id}/device-groups获取响应体中对应设备分组的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

最后修改时间。
表5 CreatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段，未使用)。

user_name

String

用户名。
表6 LastUpdatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段，未使用)。

user_name

String

用户名。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误描述。

request_id

String

消息ID。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误描述。

request_id

String

消息ID。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误描述。

request_id

String

消息ID。

请求示例

修改指定设备分组的名称和描述信息。

{
  "name" : "device_group",
  "description" : "device group"
}

响应示例

状态码：200

OK

{
  "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.update]. Parameter is [group_id]. Processor is [path].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-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

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 设备分组管理