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

DescribeThing

获取有关指定事物的信息。

请求语法:

GET /things/thingName

URI 请求参数:

名称

类型

请求?

描述

thingName

ThingName

事物的名称。

响应语法:

Content-type: application/json { "defaultClientId": "string", "thingName": "string", "thingId": "string", "thingArn": "string", "thingTypeName": "string", "attributes": { "string": "string" }, "version": "long" }

响应正文参数:

名称

类型

请求?

描述

defaultClientId

ClientId

默认客户端 ID。

thingName

ThingName

事物的名称。

thingId

事物 ID

要描述的事物的 ID。

thingArn

ThingArn

要描述的事物的 ARN。

thingTypeName

ThingTypeName

事物类型名称。

个属性

属性

事物属性。

version

版本

注册表中事物记录的当前版本。

注意

为避免意外更改注册表中的信息,您可以在 UpdateThingDeleteThing 调用的 expectedVersion 参数中传递版本信息。

错误:

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

InvalidRequestException

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

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

CLI

摘要:

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

cli-input-json format:

{ "thingName": "string" }

cli-input-json 字段:

名称

类型

描述

thingName

字符串

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

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

事物的名称。

输出:

{ "defaultClientId": "string", "thingName": "string", "thingId": "string", "thingArn": "string", "thingTypeName": "string", "attributes": { "string": "string" }, "version": "long" }

cli 输出字段:

名称

类型

描述

defaultClientId

字符串

默认客户端 ID。

thingName

字符串

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

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

事物的名称。

thingId

字符串

要描述的事物的 ID。

thingArn

字符串

要描述的事物的 ARN。

thingTypeName

字符串

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

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

事物类型名称。

个属性

map

键:AttributeName

值:AttributeValue

事物属性。

AttributeName

字符串

最大长度:128

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

AttributeValue

字符串

最大长度:800

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

version

long

注册表中事物记录的当前版本。

注意

为避免意外更改注册表中的信息,您可以在 UpdateThingDeleteThing 调用的 expectedVersion 参数中传递版本信息。

本页内容: