查看实例列表

最近更新时间:2018-10-12 16:02:48

1. 接口描述

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

本接口 (DescribeInstances) 用于查询一个或多个实例的详细信息。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstances
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 按照一个或者多个实例ID查询。实例ID形如:ins-xxxxxxxx。(此参数的具体格式可参考API简介id.N一节)。每次请求的实例的上限为100。参数不支持同时指定InstanceIdsFilters
Filters.N Array of Filter 过滤条件。
  • zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。
  • project-id - Integer - 是否必填:否 -(过滤条件)按照项目ID过滤。可通过调用DescribeProject查询已创建的项目列表或登录控制台进行查看;也可以调用AddProject创建新的项目。
  • host-id - String - 是否必填:否 - (过滤条件)按照CDH ID过滤。CDH ID形如:host-xxxxxxxx。
  • vpc-id - String - 是否必填:否 - (过滤条件)按照VPC ID进行过滤。VPC ID形如:vpc-xxxxxxxx。
  • instance-id - String - 是否必填:否 - (过滤条件)按照实例ID过滤。实例ID形如:ins-xxxxxxxx。
  • security-group-id - String - 是否必填:否 - (过滤条件)按照安全组ID过滤,安全组ID形如: sg-8jlk3f3r。
  • 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。
  • tag-key - String - 是否必填:否 - (过滤条件)按照标签键进行过滤。
  • tag-value - String - 是否必填:否 - (过滤条件)按照标签值进行过滤。
  • tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例2。

  • 每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定InstanceIdsFilters
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    InstanceSet Array of Instance 实例详细信息列表。
    RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

    4. 示例

    示例1 查看实例列表

    输入示例

    https://cvm.tencentcloudapi.com/?Action=DescribeInstances
    &Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-1
    &Filters.0.Values.1=ap-guangzhou-2
    &Offset=0
    &Limit=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceSet": [
          {
            "CPU": 1,
            "CreatedTime": "2016-12-02T00:22:40Z",
            "DataDisks": [
              {
                "DiskId": "disk-4rnslb35",
                "DiskSize": 50,
                "DiskType": "CLOUD_BASIC"
              }
            ],
            "ExpiredTime": "2017-01-02T00:22:48Z",
            "ImageId": "img-0vbqvzfn",
            "InstanceChargeType": "PREPAID",
            "InstanceId": "ins-r8hr2upy",
            "InstanceName": "测试实例",
            "InstanceType": "S1.SMALL2",
            "InternetAccessible": {
              "InternetChargeType": "BANDWIDTH_PREPAID",
              "InternetMaxBandwidthOut": 2,
              "PublicIpAssigned": "TRUE"
            },
            "Memory": 2,
            "Placement": {
              "HostId": "",
              "ProjectId": 0,
              "Zone": "ap-guangzhou-1"
            },
            "PrivateIpAddresses": [
              "10.104.37.58"
            ],
            "PublicIpAddresses": [
              "123.207.32.83"
            ],
            "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
            "SystemDisk": {
              "DiskId": "disk-4rnslbwq",
              "DiskSize": 20,
              "DiskType": "CLOUD_BASIC"
            },
            "VirtualPrivateCloud": {
              "AsVpcGateway": "TRUE",
              "SubnetId": "subnet-6d7kj98i",
              "VpcId": "vpc-4e78ea76"
            }
          }
        ],
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7",
        "TotalCount": 2
      }
    }

    示例2 查询绑定了标签的实例

    输入示例

    https://cvm.tencentcloudapi.com/?Action=DescribeInstances
    &Filters.0.Name=tag:city
    &Filters.0.Values.0=shenzhen
    &Offset=0
    &Limit=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceSet": [
          {
            "CPU": 1,
            "CreatedTime": "2016-12-02T00:22:40Z",
            "DataDisks": [
              {
                "DiskId": "disk-4rnslb35",
                "DiskSize": 50,
                "DiskType": "CLOUD_BASIC"
              }
            ],
            "ExpiredTime": "2017-01-02T00:22:48Z",
            "ImageId": "img-0vbqvzfn",
            "InstanceChargeType": "PREPAID",
            "InstanceId": "ins-r8hr2upy",
            "InstanceName": "测试实例",
            "InstanceType": "S1.SMALL2",
            "InternetAccessible": {
              "InternetChargeType": "BANDWIDTH_PREPAID",
              "InternetMaxBandwidthOut": 2,
              "PublicIpAssigned": "TRUE"
            },
            "Memory": 2,
            "Placement": {
              "HostId": "",
              "ProjectId": 0,
              "Zone": "ap-guangzhou-1"
            },
            "PrivateIpAddresses": [
              "10.104.37.58"
            ],
            "PublicIpAddresses": [
              "123.207.32.83"
            ],
            "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
            "SystemDisk": {
              "DiskId": "disk-4rnslbwq",
              "DiskSize": 20,
              "DiskType": "CLOUD_BASIC"
            },
            "Tags": [
              {
                "tagKey": "city",
                "tagValue": "shenzhen"
              }
            ],
            "VirtualPrivateCloud": {
              "AsVpcGateway": "TRUE",
              "SubnetId": "subnet-6d7kj98i",
              "VpcId": "vpc-4e78ea76"
            }
          }
        ],
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidFilter 无效的过滤器。
    InvalidFilterValue.LimitExceeded Filter参数值数量超过限制。
    InvalidHostId.Malformed 无效CDH ID。指定的CDH ID格式错误。例如ID长度错误host-1122
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidParameter 无效参数。参数不合要求或者参数不被支持等。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidZone.MismatchRegion 指定的zone不存在。

    如果有其他疑问,你也可以通过提问形式与我们联系探讨