更新时间:2022-03-23 GMT+08:00
分享

实例列表

功能介绍

获取符合条件的服务实例列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目编号

最小长度:16

最大长度:128

表2 Query参数

参数

是否必选

参数类型

描述

status

String

实例状态

最小长度:3

最大长度:128

offset

Integer

偏移量,大于等于0

最小值:0

最大值:100

缺省值:0

limit

Integer

每页显示的条目数量

最小值:0

最大值:100

缺省值:10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

最小长度:1000

最大长度:65536

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

列表总数

最小值:0

最大值:100

size

Integer

本页数量

最小值:0

最大值:100

instances

Array of instances objects

实例列表

表5 instances

参数

参数类型

描述

id

String

实例ID

name

String

实例名称

description

String

实例描述

flavor_id

String

实例规格ID

flavor_type

String

实例规格类型

cpu_arch

String

CPU架构类型,取值如下: - x86_64: x86架构 - aarch64: arm架构

缺省值:x86_64

vpc_id

String

实例指定虚拟私有云ID

subnet_id

String

实例指定虚拟私有云子网ID

security_group_id

String

实例指定安全组ID

publicip_enable

Boolean

是否开启公网访问,开启时publicip_id字段必填。

publicip_id

String

实例绑定的弹性公网地址ID

publicip_address

String

实例绑定的弹性公网地址

status

String

实例运行状态

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

charge_type

String

实例计费模式

project_id

String

租户项目ID

create_time

String

创建时间

update_time

String

更新时间

maintain_begin

String

运维开始时间

maintain_end

String

运维结束时间

available_zone_ids

Array of strings

创实例使用的可用区列表

enterprise_project_id

String

实例所属企业项目ID

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:128

error_details

String

具体错误消息

最小长度:1

最大长度:128

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:128

error_details

String

具体错误消息

最小长度:1

最大长度:128

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:128

error_details

String

具体错误消息

最小长度:1

最大长度:128

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:128

error_details

String

具体错误消息

最小长度:1

最大长度:128

request_id

String

请求处理ID

最小长度:1

最大长度:128

请求示例

响应示例

状态码: 400

Bad Request

{
  "error_code" : "ROMA.00013000",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码: 401

Unauthorized

{
  "error_code" : "ROMA.00012000",
  "error_msg" : "Incorrect token or token resolution failed",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码: 403

Forbidden

{
  "error_code" : "ROMA.00012000",
  "error_msg" : "No permissions to request this method",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码: 500

Internal Server Error

{
  "error_code" : "ROMA.00011000",
  "error_msg" : "System error",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读