AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

DescribeIndex

描述搜索索引。

请求语法:

GET /indices/indexName

URI 请求参数:

名称

类型

请求?

描述

indexName

IndexName

索引名称。

响应语法:

Content-type: application/json { "indexName": "string", "indexStatus": "string", "schema": "string" }

响应正文参数:

名称

类型

请求?

描述

indexName

IndexName

索引名称。

indexStatus

IndexStatus

索引状态。

schema

IndexSchema

包含一个特定于所执行索引类型的值。有效值为:

  1. REGISTRY - 您的事物索引将只包含注册表数据。

  2. REGISTRY_AND_SHADOW - 您的事物索引将包含注册表数据和影子数据。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

CLI

摘要:

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

cli-input-json format:

{ "indexName": "string" }

cli-input-json 字段:

名称

类型

描述

indexName

字符串

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

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

索引名称。

输出:

{ "indexName": "string", "indexStatus": "string", "schema": "string" }

cli 输出字段:

名称

类型

描述

indexName

字符串

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

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

索引名称。

indexStatus

字符串

枚举:ACTIVE | BUILDING | REBUILDING

java 类:com.amazonaws.iot.indexing.IndexStatus

索引状态。

schema

字符串

包含一个特定于所执行索引类型的值。有效值为:

  1. REGISTRY - 您的事物索引将只包含注册表数据。

  2. REGISTRY_AND_SHADOW - 您的事物索引将包含注册表数据和影子数据。

本页内容: