实例查询
更新时间：2023-10-17 17:47:08
适用产品
边缘云主机
接口描述
查询某个客户拥有的实例。
- 调用URL： https://open.chinanetcenter.com/vmp/servers
- 调用方法：GET
调用频率
单用户调用频率：300/5min
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Params 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
sortKey | String | 否 | 排序的字段名称，可以有多个，取值： name、regionName、createdAt、province、state、nodeName等 |
sortDir | String | 否 | 排序方向，必须跟在sortKey后面出现，取值： desc：降序，默认值 asc：升序 |
limit | Integer | 否 | 每个页面显示条数，默认是20 |
marker | String | 否 | 从marker指定的实例id开始查询，升序查询（若要分页查询，则不能指定sortKey参数） |
ids | String | 否 | 实例ID。单次最多查询 100 条 ID，ID 之间用半角逗号字符','隔开。 |
regionName | String | 否 | 区域名称（区域列表详见附录1：https://www.wangsu.com/document/18204/areas-list?rsr=ws） |
province | String | 否 | 实例所属省份（详见附录2：https://www.wangsu.com/document/18204/isp-list?rsr=ws） |
carrier | String | 否 | 实例所属运营商：dx-电信；wt-网通；yd-移动 |
imageId | String | 否 | 实例镜像标识 |
flavorId | String | 否 | 实例规格标识 |
name | String | 否 | 实例名称 |
state | String | 否 | 实例状态，取值（意为查询处于下述状态的虚拟机） RUNNING 运行状态 BUILDING 新建状态 STOPPED 停机 ERROR 错误 DELETING 销毁中 RESTARTING 重启中 STARTING 启动中 STOPPING 停止中 |
isFree | String | 否 | 是否免费实例，取值: YES 免费实例，NO 计费实例 |
isBm | String | 否 | 1表示只查询裸机实例， -1表示只查询虚拟机实例， 不带这个参数表示查询所有云主机 |
tags | String | 否 | 云主机标签 多个值用半角逗号隔开，多个值是或者的关系，即实例标签等于这多个中的任意一个就满足条件 |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
servers | List | 实例信息数组 |
id | String | 实例唯一标识 |
regionName | String | 实例所属区域 |
province | String | 实例所属省份 |
carrier | String | 实例所属运营商 |
imageId | String | 实例镜像信息 |
flavorId | String | 实例规格 |
name | String | 实例名称 |
state | String | 实例状态 |
createdAt | String | 实例创建时间 |
accessIPv4 | String | 实例IP地址 |
privateIPv4 | String | 实例内网IP地址，如果创建实例时指定了需要内网，则返回内网IP，否则是空 |
keyName | String | 实例登录SSH秘钥对名称 |
nodeName | String | 节点名称，实例所在节点名称，通过这个节点名称可以查询每个节点的实时冗余带宽情况 |
accessIP | List | 实例ip地址 |
address | String | Ip地址 |
carrier | String | Ip地址所属运营商 |
protocol | Integer | 协议类型：4：ipv4地址；6：ipv6地址 |
isFree | String | 是否免费实例，取值：YES 免费实例，NO 计费实例 |
isBm | Integer | 1表示该实例是裸机 -1表示该实例是虚拟机 |
securityGroupIds | List | 实例绑定的安全组id列表 |
diskInfo | List | 磁盘信息 |
size | Integer | 磁盘大小（GB） |
type | String | 磁盘用途：SYSTEM-系统盘；DATA-数据盘 |
category | String | 磁盘类型：HDD/SSD |
tag | String | 实例标签 |
示例
JSON
- 请求示例 复制成功
GET /servers?ids=6b787ef3-079f-4052-9afd-145f80eb698c GET/servers?sortKey=name&sortDir=asc®ionName=huanan&state=RUNNING
- 返回示例 复制成功
{ "servers": [ { "id": "6b787ef3-079f-4052-9afd-145f80eb698c", "regionName": "huanan", "province": "guangdong", "carrier": "yd", "imageId": "70a599e0-31e7-49b7-b260-868f441e862b", "createdAt": "2017-02-14 19:24:42", "flavor": "1", "name": "server_001", "state": "RUNNING", "accessIPv4": "27.158.151.187", "privateIPv4": "172.20.30.10", "nodeName": "GD-foshan2-YD", "accessIP": [{ "address": "27.158.151.187", "carrier": "yd", "protocol": 4 },{ "address": "2408:8752:500::6", "carrier": "yd", "protocol": 6 }], "isBm": -1, "securityGroupIds": ["11ceeeafa1d64c96b95d3a8c45bf7431","3b1da8aceeda42b4b3e23e723f88ffe9"], "diskInfo": [{ "size": 40, "type": "SYSTEM", "category": "SSD" }] }, { "id": "ce0bdfd2-617d-4373-8d33-e5f268310aee", "regionName": "huanan", "province": "guangdong", "carrier": "yd", "image": "70a599e0-31e7-49b7-b260-868f441e862b", "createdAt": "2017-02-15 19:24:42", "flavor": "1", "name": "server_002", "state": "RUNNING", "accessIPv4": "27.158.151.188", "privateIPv4": "172.20.30.11", "nodeName": "GD-foshan2-YD", "accessIP": [{ "address": "27.158.151.188", "carrier": "yd", "protocol": 4 },{ "address": "2408:8752:500::7", "carrier": "yd", "protocol": 6 }], "isBm": -1, "securityGroupIds": [], "diskInfo": [{ "size": 40, "type": "SYSTEM", "category": "SSD" }, { "size": 300, "type": "DATA", "category": "SSD" }] } ] }
本篇文档内容对您是否有帮助？
有帮助
我要反馈