查看实例列表

最近更新时间:2019-10-12 16:25:36

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

本接口 (DescribeInstances) 用于查询一个或多个实例的详细信息。
接口请求域名:cvm.api.qcloud.com

  • 可以根据实例ID、实例名称或者实例计费模式等信息来查询实例的详细信息。过滤信息详细请见过滤器Filter
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的实例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 类型 是否必选 描述
Version String 表示API版本号,主要用于标识请求的不同API版本。 本接口第一版本可传:2017-03-12。
InstanceIds.N array of Strings 按照一个或者多个实例 ID 查询。实例 ID 形如:ins-11112222。此参数的具体格式可参考 API 简介id.N一节)。每次请求的实例的上限为100。参数不支持同时指定InstanceIdsFilters
Filters.N array of Filter objects 过滤条件,详见下表:实例过滤条件表。每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定InstanceIdsFilters
Offset Integer 偏移量,默认为0。
Limit Integer 返回数量,默认为20,最大值为100。

实例过滤条件表

参数名称 类型 是否必选 描述
zone String (过滤条件)按照可用区过滤。
project-id Integer (过滤条件)按照项目 ID 过滤。可通过调用 DescribeProject 查询已创建的项目列表或登录 控制台 进行查看;也可以调用 AddProject 创建新的项目。
host-id String (过滤条件)按照 CDH ID过滤。CDH ID形如:host-11112222
instance-id String (过滤条件)按照实例ID过滤。实例ID形如:ins-11112222
instance-name String (过滤条件)按照实例名称过滤。
instance-charge-type String (过滤条件)按照实例计费模式过滤。取值范围:
  • PREPAID:表示预付费,即包年包月。
  • POSTPAID_BY_HOUR:表示后付费,即按量计费。
  • CDHPAID:表示 CDH 付费,即只对 CDH 计费,不对 CDH 上的实例计费。
  • private-ip-address String (过滤条件)按照实例主网卡的内网IP过滤。
    public-ip-address String (过滤条件)按照实例主网卡的公网IP过滤,包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP

    3. 输出参数

    参数名称 类型 描述
    RequestId<