查询实例列表
功能介绍
查询实例列表,支持通过多个参数进行过滤和分页。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
availability_zone |
否 |
String |
可用区 |
charge_mode |
否 |
String |
计费模式 |
create_time |
否 |
Long |
创建时间 |
deploy_mode |
否 |
String |
部署模式 |
fail_reason |
否 |
String |
失败原因 |
id |
否 |
String |
实例ID |
mode |
否 |
String |
模式 |
name |
否 |
String |
实例名称 |
limit |
否 |
Integer |
每页显示数量 |
offset |
否 |
Long |
偏移量 |
page_number |
否 |
Integer |
页码 |
page_size |
否 |
Integer |
每页大小 |
paged |
否 |
Boolean |
是否分页 |
public_ip_id |
否 |
String |
公网IP ID |
sort_sorted |
否 |
Boolean |
是否排序 |
sort_unsorted |
否 |
Boolean |
是否未排序 |
specification |
否 |
String |
规格 |
status |
否 |
Integer |
状态 |
type |
否 |
String |
类型 |
unpaged |
否 |
Boolean |
是否无分页 |
version |
否 |
String |
版本 |
virtual_ip |
否 |
String |
虚拟IP |
vpc_id |
否 |
String |
VPC ID |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Long |
总数量 |
items |
Array of InstanceVo objects |
实例列表 |
参数 |
参数类型 |
描述 |
---|---|---|
availability_zone |
String |
可用区 |
charge_mode |
String |
计费模式 |
create_time |
Long |
创建时间 |
deploy_mode |
String |
部署模式 |
fail_reason |
String |
失败原因 |
id |
String |
实例ID |
mode |
String |
模式 |
name |
String |
实例名称 |
public_ip |
String |
公网IP |
publicip_id |
String |
公网IP ID |
region |
String |
区域 |
security_group_id |
String |
安全组ID |
specification |
String |
规格 |
started_time |
Long |
启动时间 |
status |
Integer |
状态 |
subnet_id |
String |
子网ID |
type |
String |
类型 |
update_info |
InstanceUpgradeInfo object |
实例升级相关信息 |
upgrade_process |
Integer |
升级进度 |
version |
String |
版本 |
virtual_ip |
String |
虚拟IP |
vpc_id |
String |
VPC ID |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
未授权 |
403 |
禁止访问 |
404 |
未找到 |
错误码
请参见错误码。