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