DescribeInstances
1. 接口描述
调用本接口用于查询一台或多台虚拟机实例的信息。用户可以根据实例ID、实例名称或者实例计费模式等条件来查询实例的详细信息。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
3. 响应结果
4. 代码示例
分页查询虚拟机实例列表
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. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误
最后更新于