DescribeInstances

1. 接口描述

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

2. 请求参数

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

参数名称	必选	类型	描述
instanceIds	否	Array of String	虚拟机实例ID。 最多支持100个ID查询。
zoneId	否	String	实例所属的可用区ID。
resourceGroupId	否	String	资源组的ID。 如果不传，则返回该用户可见的所有资源组内的实例。
instanceType	否	String	实例机型。 具体取值可通过调用接口DescribeZoneInstanceConfigInfos来获得最新的规格表。
internetChargeType	否	String	网络计费类型。 取值范围详见InternetChargeType。
imageId	否	String	镜像ID。
keyId	否	String	密钥ID。
subnetId	否	String	虚拟子网ID 。 可以调用DescribeSubnets查询已创建交换机的相关信息。
instanceStatus	否	String	实例状态。 状态类型详见实例状态。
instanceName	否	String	实例显示名称。 如果该值以*结尾，则对instanceName进行模糊匹配，否则将进行精确匹配。
securityGroupId	否	String	安全组ID。
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/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeInstances
<Common Request Params>

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

Response:
{
    "requestId":"T4E7FED5D-4A69-4B4B-AF57-BCD20BDC053A",
    "response":{
        "requestId":"T4E7FED5D-4A69-4B4B-AF57-BCD20BDC053A",
        "dataSet":[
            {
                "instanceId":"instanceIdxxxxx",
                "zoneId":"SAO-A",
                "instanceName":"Ubuntu-1c2g-web",
                "instanceType":"c.1c2g",
                "autoRenew":true,
                "cpuCount":1,
                "memory":2,
                "imageId":"img-prEjRbTonNiUyuhSrLrJB2gTk",
                "imageName":"Ubuntu-20.04",
                "instanceChargeType":"PREPAID",
                "internetMaxBandwidthOut":1,
                "internetChargeType":"ByBandwidth",
                "period":1,
                "publicIpAddresses":[
                    "128.1.1.1"
                ],
                "privateIpAddresses":[
                    "10.0.1.0"
                ],
                "subnetId":"your-subnet-id",
                "createTime":"2023-03-01T00:00:00Z",
                "expiredTime":"2023-03-31T00:00:00Z",
                "resourceGroupId":"default-resource-group-id",
                "resourceGroupName":"Default Resource Group",
                "instanceStatus":"RUNNING",
                "securityGroupIds":[
                    "843869472514124338"
                ],
                "systemDisk":{
                    "diskId":"your disk id",
                    "diskSize":30
                }
            }
        ],
        "totalCount":1
    }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明