V2.5 Get Device Group¶

Get device group information.

Request Format¶

GET https://{apigw-address}/connect-service/v2.5/deviceGroups?action=getGroup

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset belongs to. How to get orgId>>
groupId	Query	Mandatory	String	Device group ID.

Response Parameters¶

Name	Data Type	Description
code	Number	Return code of a request.
msg	String	The explanation to the return code. Its value is `OK` if the request is
requestId	String	A unique ID to identify a request.
data	Device Struct Array	For more information, see Device Struct.

Device Struct ¶

Name	Data Type	Description
groupId	String	Device group ID
orgId	String	Organization ID.
name	StringI18n	Device group name. For more details on the structure and locales supported, see Internationalized name struct.
desc	String	Device group description.
type	String	Device group type: STATIC, DYNAMIC.
condition	String	Conditions of the dynamic device group
createTime	Number	Create time.
updateTime	Number	Update time.

Samples¶

Request Sample¶

url: https://{apigw-address}/connect-service/v2.5/deviceGroups?action=getGroup&orgId=yourOrgId&groupId=yourGroupId
method: GET

Return Sample¶

{
  "code": 0,
  "msg": "OK",
  "requestId": "39d882e7-8cf9-4f6e-863f-dd65bb2af7a4",
  "data": {
    "groupId": "yourGroupId",
    "orgId": "yourOrgId",
    "name": {
      "defaultValue": "GroupName_test",
      "i18nValue": {
        "en_US": "name",
        "zh_CN": "中文名",
        "es_ES": "nombre",
        "ja_JP": "名前"
      }
    },
    "desc": "GroupDescription",
    "type": "STATIC",
    "condition": null,
    "status": "ACTIVE",
    "createTime": 1718950104553,
    "updateTime": 1718950124698
  }
}