DescribeInstances

1. 接口描述

调用本接口用于查询一台或多台实例的信息。用户可以根据实例ID、实例名称或者实例计费模式等条件来查询实例的详细信息。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
instanceIds	否	Array of String	实例ID。 最多支持100个ID查询。
zoneId	否	String	实例所属的可用区ID。
resourceGroupId	否	String	资源组的ID。 如果不传，则返回该用户可见的所有资源组内的实例。
instanceTypeId	否	String	实例机型ID。 具体取值可通过调用接口DescribeInstanceTypes来获得最新的规格表。
internetChargeType	否	String	网络计费类型。 取值范围请看InternetChargeType。
imageId	否	String	镜像ID。
subnetId	否	String	虚拟子网ID 。 可以调用DescribeVpcSubnets查询已创建交换机的相关信息。
instanceStatus	否	String	实例状态。 状态类型详见实例状态。
instanceName	否	String	实例显示名称。 如果该值以*结尾，则对instanceName进行模糊匹配，否则将进行精确匹配。
hostname	否	String	实例的主机名。 如果该值以*结尾，则对hostname进行模糊匹配，否则将进行精确匹配。
publicIpAddresses	否	Array of String	公网ipv4地址。
privateIpAddresses	否	Array of String	内网子网的ipv4地址。
pageSize	否	Integer	返回的分页大小。 默认为20，最大为1000。
pageNum	否	Integer	返回的分页数。 默认为1。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount	Integer	符合条件的数据总数。
dataSet	Array of InstanceInfo	结果集。

4. 代码示例

示例

1. 分页查询实例列表

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeImages
<Common Request Params>

Request:
{
  "pageNum": 1,
  "pageSize": 1
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "totalCount": 6,
    "dataSet": [
      {
        "instanceId": "instanceId",
        "zoneId": "HKG-A",
        "instanceName": "TEST",
        "hostname": "M7D-HKG-A-01",
        "instanceTypeId": "M7D",
        "imageId": "imageId",
        "imageName": "Ubuntu18.04-x86_64",
        "instanceChargeType": "POSTPAID",
        "bandwidthOutMbps": 0,
        "internetChargeType": "ByClusterBandwidth95",
        "period": null,
        "primaryPublicIpAddress": "1.1.1.1",
        "publicIpAddresses": [
          "1.1.1.1",
          "2.2.2.2"
        ],
        "privateIpAddresses": [
          "10.0.0.1"
        ],
        "ipv6Addresses": [
          "2602:ffe4:1:11::1"
        ],
        "subnetIds": [
          "subnetId"
        ],
        "createTime": "2023-01-01T00:00:00Z",
        "expiredTime": null,
        "resourceGroupId": "resourceGroupId",
        "instanceStatus": "RUNNING",
        "trafficPackageSize": 1.5,
        "raidConfig": {
          "raidType": null,
          "customRaids": [
            {
              "raidType": 1,
              "diskSequence": [
                12,
                13
              ]
            }
          ]
        },
        "partitions": [
          {
            "fsPath": "/",
            "fsType": "ext2",
            "size": 1100
          }
        ],
        "nic": {
          "wanName": "wan0",
          "lanName": "lan0"
        },
        "autoRenew": true
      }
    ]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	IMAGE_NOT_FOUND	指定的镜像不存在。
404	INVALID_ZONE_NOT_FOUND	指定的区域不存在。
404	INVALID_INSTANCE_TYPE_NOT_FOUND	指定的机型不存在。