API文档

查询VPC下的云主机实例列表

最近更新时间:2020-07-13 08:53:08

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeVpcInstances)用于查询VPC下的云主机实例列表。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpcInstances。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤条件,参数不支持同时指定RouteTableIds和Filters。
  • vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。
  • instance-id - String - (过滤条件)云主机实例ID。
  • instance-name - String - (过滤条件)云主机名称。
  • Offset Integer 偏移量。
    Limit Integer 请求对象个数。

    3. 输出参数

    参数名称 类型 描述
    InstanceSet Array of CvmInstance 云主机实例列表。
    TotalCount Integer 满足条件的云主机实例个数。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询VPC下的云主机实例列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeVpcInstances
    &Version=2017-03-12
    &Filters.0.Name=vpc-id
    &Filters.0.Values.0=vpc-12345678
    &Offset=0
    &Limit=10
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceSet": [
          {
            "VpcId": "vpc-12345678",
            "SubnetId": "subnet-12345678",
            "InstanceId": "ins-12345678",
            "InstanceName": "test",
            "InstanceState": "RUNNING",
            "InstanceType": "S2.SMALL2",
            "CPU": 1,
            "Memory": 1,
            "EniLimit": 2,
            "EniIpLimit": 2,
            "InstanceEniCount": 1,
            "CreatedTime": "2020-01-01 10:00:00"
          }
        ],
        "TotalCount": 1,
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。
    目录