2.3.2.2. list

列表 方法检索集合中多个对象的表示。

列出虚拟机集合

# Find the service that manages the collection of virtual
# machines:
vms_service = system_service.vms_service
vms = vms_service.list

结果是一个 Ruby 数组，其中包含相应类型的实例。在上例中，响应是 Ruby 类 Vm 的实例列表。

某些服务的列表 方法支持额外的参数。

例如，几乎所有顶级集合都支持 search 参数，用于过滤结果，而 max 参数用于限制服务器返回的结果数。

列出调用"my*"的虚拟机

vms = vms_service.list(search: 'name=my*', max: 10)

注意

不是所有列表方法都支持 search 或 max 参数。些列表方法可能支持其他参数。详情请查看参考文档。

如果结果列表为空，则返回的值是空的 Ruby 数组。它永远不会为 nil。

如果无法检索结果列表，则 SDK 会产生一个包含失败详情的 Error 异常。