CDN加速

实例查询

更新时间:2021-06-16 10:55:12
适用产品:边缘云主机

接口描述

查询某个客户拥有的实例。

请求参数

参数名称类型必填描述
sortKeystring排序的字段名称,可以有多个,取值: name、regionName、createdAt、province、state、nodeName等
sortDirstring排序方向,必须跟在sortKey后面出现,取值: desc:降序,默认值 asc:升序
limitinteger每个页面显示条数,默认是20
markerstring从marker指定的实例id开始查询
idsstring实例ID。单次最多查询 100 条 ID,ID 之间用半角逗号字符“,”隔开。
regionNamestring区域名称,如华南区域就是huanan,参考附录3
provincestring实例所属省份
carrierstring实例所属运营商
imageIdstring实例镜像标识
flavorIdstring实例规格标识
namestring实例名称
statestring实例状态,取值(意为查询处于下述状态的虚拟机) RUNNING 运行状态 BUILDING 新建状态 STOPPED 停机 ERROR 错误 DELETING 销毁中 RESTARTING 重启中 STARTING 启动中 STOPPING 停止中
isFreestring是否免费实例,取值: YES 免费实例,NO 计费实例
isBmstring1表示只查询裸机实例, -1表示只查询虚拟机实例, 不带这个参数表示查询所有云主机
tagsstring云主机标签 多个值用半角逗号隔开,多个值是或者的关系,即实例标签等于这多个中的任意一个就满足条件

返回参数

参数名称类型描述
serversarray实例信息数组
idstring实例唯一标识
regionNamestring实例所属区域
provincestring实例所属省份
carrierstring实例所属运营商
imageIdstring实例镜像信息
flavorIdstring实例规格
namestring实例名称
statestring实例状态
createdAtstring实例创建时间
accessIPv4string实例IP地址
privateIPv4string实例内网IP地址,如果创建实例时指定了需要内网,则返回内网IP,否则是空
keyNamestring实例登录SSH秘钥对名称
nodeNamestring节点名称,实例所在节点名称,通过这个节点名称可以查询每个节点的实时冗余带宽情况
accessIParray实例ip地址
accessIP.addressstringIp地址
accessIP.carrierstringIp地址所属运营商
accessIP.protocolinteger协议类型:4:ipv4地址;6:ipv6地址
isFreestring是否免费实例,取值:YES 免费实例,NO 计费实例
isBminteger1表示该实例是裸机 -1表示该实例是虚拟机
securityGroupIdsarray实例绑定的安全组id列表
diskInfoarray磁盘信息
diskInfo.sizeinteger磁盘大小(GB)
diskInfo.typestring磁盘用途:SYSTEM-系统盘;DATA-数据盘
diskInfo.categorystring磁盘类型:HDD/SSD
tagstring实例标签

示例

示例说明
请求示例
复制
GET /servers?Ids=6b787ef3-079f-4052-9afd-145f80eb698c
GET/servers?sortKey=name&sortDir=asc&regionName=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"
	}]
    }
    ]
}