ListRobots - AWS RoboMaker

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ListRobots

此操作已弃用。

重要

不再支持该 API。有关更多信息,请参阅 Support 政策页面 2022 年 5 月 2 日更新的内容。

返回机器人列表。您可以选择提供筛选器检索特定机器人。

请求语法

POST /listRobots HTTP/1.1 Content-type: application/json { "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string" }

URI 请求参数

该请求不使用任何 URI 参数。

请求体

请求接受采用 JSON 格式的以下数据。

filters

用于限制结果的可选筛选器。

支持筛选器名称 statusfleetName。筛选时,必须使用已筛选项目的完整值。最多可以使用三个筛选器,但它们必须用于同名项目。例如,如果您正在寻找状态 Registered 或状态 Available 的商品。

类型:Filter 对象数组

数组成员:固定数量为 1 项。

必需:否

maxResults

使用此参数时,ListRobots 仅在单个页面中返回 maxResults 个结果以及 nextToken 响应元素。通过发送另一个带有返回 ListRobots 值的 nextToken 请求,可以看到初始请求的其余结果。该值必须在 1 到 200 之间。如果不使用此参数,则 ListRobots 最多返回 200 个结果和一个 nextToken 值(如果适用)。

类型:整数

必需:否

nextToken

如果之前的分页请求未返回所有剩余结果,则响应对象的 nextToken 参数值将设置为令牌。要检索下一组结果,请再次调用 ListRobots 并将该令牌分配给请求对象的 nextToken 参数。如果没有剩余的结果,则前一个响应对象的 NextToken 参数设置为 null。

类型:字符串

长度限制:最小长度为 0。最大长度为 2048。

模式:[a-zA-Z0-9_.\-\/+=]*

必需:否

响应语法

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "robots": [ { "architecture": "string", "arn": "string", "createdAt": number, "fleetArn": "string", "greenGrassGroupId": "string", "lastDeploymentJob": "string", "lastDeploymentTime": number, "name": "string", "status": "string" } ] }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

nextToken

如果之前的分页请求未返回所有剩余结果,则响应对象的 nextToken 参数值将设置为令牌。要检索下一组结果,请再次调用 ListRobots 并将该令牌分配给请求对象的 nextToken 参数。如果没有剩余的结果,则前一个响应对象的 NextToken 参数设置为 null。

类型:字符串

长度限制:最小长度为 0。最大长度为 2048。

模式:[a-zA-Z0-9_.\-\/+=]*

robots

满足请求标准的机器人列表。

类型:Robot 对象数组

数组成员:最少 0 个物品。最多 1000 项。

错误

有关所有操作的常见错误信息,请参阅常见错误

InternalServerException

AWS RoboMaker 遇到了服务问题。重新尝试您的调用。

HTTP 状态代码:500

InvalidParameterException

在请求中指定的参数无效、不受支持,或无法使用。请求的消息解释错误值。

HTTP 状态代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 状态代码:400

ThrottlingException

AW RoboMaker S 暂时无法处理该请求。重新尝试您的调用。

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: