ListDeviceGroups - 批量查询设备标签列表

更新时间:
复制 MD 格式

分页查询当前阿里云账号下的设备组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

CurrentPage

integer

分页查询时显示的当前页的页码。取值:1~10000。

1

PageSize

integer

分页查询时设置的每页数量。取值:1~500。

10

Name

string

设备标签名称。长度不超过 128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

公共服务系统用户组

DeviceGroupIds

array

设备组 ID 集合,不允许重复。

string

设备组 ID。取值来源:

device-group-5191cf830a5e****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

FD724DBC-CD76-5235-BF76-59C51B73296D

TotalNum

integer

设备标签总数。

1

DeviceGroups

array<object>

设备标签列表。

object

设备标签。

Name

string

设备标签名称。

example

Description

string

设备标签描述。

description

DeviceGroupId

string

设备标签 ID。

device-group-5191cf830a5e****

IsDefault

string

是否为系统内置设备标签。取值:

  • true:系统内置设备标签。

  • false:用户自定义设备标签。

枚举值:

  • true :

    系统内置

  • false :

    用户自定义

false

MatchDevTags

array

设备标签已关联的终端设备 ID 集合。

string

设备标签已关联的终端设备 ID。

36efa42d-2c32-c4dc-e3fc-8541e33a****

GroupType

string

设备标签类型。取值:

  • static:静态设备标签,成员由手动添加的终端设备构成。

  • dynamic:动态设备标签,成员由匹配规则在终端设备上报心跳时自动计算。

枚举值:

  • static :

    静态设备标签

  • dynamic :

    动态设备标签

static

DynamicOperator deprecated

string

动态设备组规则算子。

AND

DynamicRule Rule

动态设备标签的匹配规则。

示例

正常返回示例

JSON格式

{
  "RequestId": "FD724DBC-CD76-5235-BF76-59C51B73296D",
  "TotalNum": 1,
  "DeviceGroups": [
    {
      "Name": "example",
      "Description": "description",
      "DeviceGroupId": "device-group-5191cf830a5e****",
      "IsDefault": "false",
      "MatchDevTags": [
        "36efa42d-2c32-c4dc-e3fc-8541e33a****"
      ],
      "GroupType": "static",
      "DynamicOperator": "AND",
      "DynamicRule": {
        "Id": "1361",
        "RuleType": "device_info",
        "RuleSubType": "windows",
        "Name": "mac",
        "Operator": "equal",
        "Values": [
          "windows"
        ],
        "Combinator": "AND",
        "Rules": [
          {
            "Id": "1361",
            "RuleType": "device_info",
            "RuleSubType": "windows",
            "Name": "mac",
            "Operator": "equal",
            "Values": [
              "windows"
            ],
            "Combinator": "AND",
            "Rules": [
              {
                "Id": "1361",
                "RuleType": "device_info",
                "RuleSubType": "windows",
                "Name": "mac",
                "Operator": "equal",
                "Values": [
                  "windows"
                ],
                "Combinator": "AND",
                "Rules": []
              }
            ]
          }
        ]
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情