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

ListTopicRules

ListTopicRules

列出特定主题的规则。

https

请求语法:

GET /rules?topic=topic&maxResults=maxResults&nextToken=nextToken&ruleDisabled=ruleDisabled

URI 请求参数:

名称

类型

请求?

描述

topic

主题

主题。

maxResults

GEMaxResults

要返回的最大结果数量。

nextToken

NextToken

用于检索下一个值的令牌。

ruleDisabled

IsDisabled

指定是否禁用规则。

响应语法:

Content-type: application/json { "rules": [ { "ruleArn": "string", "ruleName": "string", "topicPattern": "string", "createdAt": "timestamp", "ruleDisabled": "boolean" } ], "nextToken": "string" }

响应正文参数:

名称

类型

请求?

描述

规则

TopicRuleList

规则。

nextToken

NextToken

用于检索下一个值的令牌。

错误:

InternalException

出现意外错误。

HTTP 响应代码:500

InvalidRequestException

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

HTTP 响应代码:400

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

cli

摘要:

aws iot list-topic-rules \ [--topic <value>] \ [--max-results <value>] \ [--next-token <value>] \ [--rule-disabled | --no-rule-disabled] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "topic": "string", "maxResults": "integer", "nextToken": "string", "ruleDisabled": "boolean" }

cli-input-json 字段:

名称

类型

描述

topic

字符串

主题。

maxResults

integer

范围 - 最大值:10000,最小值:1

要返回的最大结果数量。

nextToken

字符串

用于检索下一个值的令牌。

ruleDisabled

布尔值

指定是否禁用规则。

输出:

{ "rules": [ { "ruleArn": "string", "ruleName": "string", "topicPattern": "string", "createdAt": "timestamp", "ruleDisabled": "boolean" } ], "nextToken": "string" }

cli 输出字段:

名称

类型

描述

规则

列表

成员:TopicRuleListItem

规则。

ruleArn

字符串

规则 ARN。

ruleName

字符串

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

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

规则的名称。

topicPattern

字符串

应用的主题名称的模式。

createdAt

timestamp

创建规则的日期和时间。

ruleDisabled

布尔值

指定是否禁用规则。

nextToken

字符串

用于检索下一个值的令牌。

错误:

InternalException

出现意外错误。

InvalidRequestException

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

ServiceUnavailableException

服务暂时不可用。