AWS IoT
开发人员指南
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

DescribeThingGroup

描述事物组。

请求语法:

GET /thing-groups/thingGroupName

URI 请求参数:

名称

类型

请求?

描述

thingGroupName

ThingGroupName

事物组的名称。

响应语法:

Content-type: application/json { "thingGroupName": "string", "thingGroupId": "string", "thingGroupArn": "string", "version": "long", "thingGroupProperties": { "thingGroupDescription": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" } }, "thingGroupMetadata": { "parentGroupName": "string", "rootToParentThingGroups": [ { "groupName": "string", "groupArn": "string" } ], "creationDate": "timestamp" } }

响应正文参数:

名称

类型

请求?

描述

thingGroupName

ThingGroupName

事物组的名称。

thingGroupId

ThingGroupId

事物组 ID。

thingGroupArn

ThingGroupArn

事物组 ARN。

version

版本

事物组的版本。

thingGroupProperties

ThingGroupProperties

事物组属性。

thingGroupMetadata

ThingGroupMetadata

事物组元数据。

错误:

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

InternalFailureException

出现意外错误。

HTTP 响应代码:500

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

CLI

摘要:

aws iot describe-thing-group \ --thing-group-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "thingGroupName": "string" }

cli-input-json 字段:

名称

类型

描述

thingGroupName

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9:_-]+

事物组的名称。

输出:

{ "thingGroupName": "string", "thingGroupId": "string", "thingGroupArn": "string", "version": "long", "thingGroupProperties": { "thingGroupDescription": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" } }, "thingGroupMetadata": { "parentGroupName": "string", "rootToParentThingGroups": [ { "groupName": "string", "groupArn": "string" } ], "creationDate": "timestamp" } }

cli 输出字段:

名称

类型

描述

thingGroupName

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9:_-]+

事物组的名称。

thingGroupId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9-]+

事物组 ID。

thingGroupArn

字符串

事物组 ARN。

version

long

事物组的版本。

thingGroupProperties

ThingGroupProperties

事物组属性。

thingGroupDescription

字符串

最大长度:2028

模式:[\\p {Graph}]*

事物组的描述。

attributePayload

AttributePayload

JSON 格式的事物组属性。

个属性

map

键:AttributeName

值:AttributeValue

一个 JSON 字符串,其中最多包含三个 JSON 格式的键/值对。例如:

\"attributes\":{\"string1\":\"string2\"}

AttributeName

字符串

最大长度:128

模式:[a-zA-Z0-9_.,@/:#-]+

AttributeValue

字符串

最大长度:800

模式:[a-zA-Z0-9_.,@/:#-]*

merge

布尔值

指定在 AttributePayload 中提供的属性列表是否与存储在注册表中的属性合并,而不是覆盖。

要删除属性,请使用空属性值调用 UpdateThing

注意

merge 属性仅在调用 UpdateThing 时有效。

thingGroupMetadata

ThingGroupMetadata

事物组元数据。

parentGroupName

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9:_-]+

父事物组的名称。

rootToParentThingGroups

列表

成员:GroupNameAndArn

java 类:java.util.List

根父事物组。

GroupNameAndArn

GroupNameAndArn

groupName

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9:_-]+

组名称。

groupArn

字符串

组 ARN。

creationDate

timestamp

创建事物组的时间的 UNIX 时间戳。

本页内容: