文档首页> 华为云Flexus云服务_Flexus应用服务器L实例> API参考> API> 查询Flexus L实例云主机详情列表
更新时间:2024-07-24 GMT+08:00
分享

查询Flexus L实例云主机详情列表

功能介绍

根据用户请求条件筛选、查询所有的云主机,并关联获取云主机的详细信息。

该接口支持查询云主机计费方式,以及是否被冻结。

接口约束

当前云主机详情列表中未包含包年/包云主机到期时间,如需获取,可以通过客户运营能力相关接口进行查询,详细内容,请参见查询客户包年/包月资源列表

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={status}&limit={limit}&offset={offset}&not-tags={not-tags}&reservation_id={reservation_id}&enterprise_project_id={enterprise_project_id}&tags={tags}&ip={ip}

参数说明请参见表1
表1 路径参数

参数

是否必选

描述

project_id

项目ID。

获取方法请参见获取项目ID

表2 查询参数

参数

是否必选

参数类型

描述

offset

Integer

页码。

当前页面数,默认值为1,取值范围大于等于0。

当取值为0时,系统默认返回第1页,与取值为1时相同。

建议设置该参数大于等于1。

flavor

String

云主机规格ID。

name

String

名称,匹配规则为模糊匹配。

支持特殊字符,例如,"." 匹配除换行符(\n、\r)之外的任何单个字符,相等于 [^\n\r]。

status

String

云主机状态。

取值范围:

ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED、SHELVED、SHELVED_OFFLOADED 、UNKNOWN

状态说明请参考云服务器状态

说明:

当处于中间状态时,查询范围如下:

  • ACTIVE,查询范围:ACTIVE,REBOOT,HARD_REBOOT,REBUILD,MIGRATING、RESIZE
  • SHUTOFF,查询范围:SHUTOFF,RESIZE,REBUILD
  • ERROR,查询范围:ERROR,REBUILD
  • VERIFY_RESIZE,查询范围:VERIFY_RESIZE,REVERT_RESIZE

limit

Integer

查询返回列表当前页面的数量。

每页默认值是25,最多返回1000台的信息,如果数据量过大建议设置成100。

tags

String

查询tag字段中包含该值的。

not-tags

String

查询tag字段中不包含该值的。

示例:查询的列表中不包含裸金属服务器,该字段设置如下:not-tags=__type_baremetal

reservation_id

String

使用Openstack Nova 接口批量创建时,会返回该ID,用于查询本次批量创建的。

enterprise_project_id

String

查询绑定某个企业项目的。

若需要查询当前用户所有企业项目绑定的,请传参all_granted_eps

说明:
  • 查询的企业项目需具备ecs:cloudServers:list的权限。

    如果用户只有某个企业项目的权限,则需要传递该参数,查询指定企业项目绑定的,否则会因权限不足而报错。

  • 当前all_granted_eps支持查询的企业项目个数不超过100。

ip

String

IPv4地址过滤结果,匹配规则为模糊匹配。

此处IP为的私有IP。

ip_eq

String

IPv4地址过滤结果,匹配规则为精确匹配。

此处IP为云主机的私有IP。

server_id

String

云主机ID,格式为UUID,匹配规则为精确匹配

示例:server_id={id1}&server_id={id2}

说明:
  • 在使用server_id作为过滤条件时,不能同时使用其他过滤条件。如果同时指定server_id及其他过滤条件,则以server_id条件为准,其他过滤条件会被忽略
  • 当server_id中含有不存在的云主机ID时,返回的响应参数中该云主机ID对应的servers结构体中除了id和fault其它字段均为null
  • 为了避免API的URI过长,建议一次查询的server_id个数不超过100个

相关信息

本接口复用ECS相应接口,响应参数说明、接口使用示例、返回值等信息详见ECS文档查询云服务器详情,该文档内容同样适用于Flexus L实例云主机。

ECS接口信息中,FlexusL实例中的云主机对应于弹性云服务器。

分享:

    相关文档

    相关产品