文档首页 > > API参考> API> IDE实例管理>

查询IDE实例列表

查询IDE实例列表

分享
更新时间:2021/03/01 GMT+08:00

功能介绍

查询IDE实例列表

调试

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

URI

GET /v2/instances

表1 Query参数

参数

是否必选

参数类型

描述

limit

Long

每页显示的条目数量 10/15/30

offset

Long

偏移量,表示从此偏移量开始查询

is_temporary

Boolean

是否页面显示(以标签配置为准)

label

String

标签

search

String

关键字查询(根据实例名,描述模糊查询)

sort_dir

String

排序方式 asc/desc

sort_key

String

排序字段。 display_name 实例名、status状态、pvc_quantity 存储容量、created_time 创建时间、stack_id 技术栈

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

instances

PageInstancesVO object

实例列表

status

String

状态

表4 PageInstancesVO

参数

参数类型

描述

empty

Boolean

是否为空

items

Array of InstancesVO objects

列表详情

items_before

Long

偏移量,表示从此偏移量开始查询

size

Long

每页显示的条目数量

total_items_count

Long

总数

表5 InstancesVO

参数

参数类型

描述

action_list

Array of RoleAction objects

角色权限列表

arch

String

cpu架构 x86|arm

枚举值:

  • x86

  • arm

attributes

Attributes object

属性

cpu_memory

String

cpu规格.arm架构支持4U8G,x86架构支持1U1G,2U4G,2U8G 与技术栈配置的规格对应,可通过技术栈管理ListStacksByTag接口获取。如果标签不为空,以标签配置的技术栈规格为准。 quantum技术栈,x86架构cpu规格为2U8G;其他技术栈,x86架构cpu规格为1U1G,2U4G

枚举值:

  • 1U1G

  • 2U4G

  • 2U8G

  • 4U8G

created_time

String

创建时间

description

String

描述

display_name

String

实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间

domain_name

String

组织名

id

String

id

is_temporary

Boolean

是否页面显示(以标签配置为准)

label

String

标签

link

String

链接

name

String

名称

organization_id

String

组织id(对应华为云帐号的domainId)

owner_id

String

用户id

owner_name

String

用户名

platform_id

Long

平台ID

private

Boolean

是否私有平台

pvc_quantity

String

PVC规格 5GB|10GB|20GB

枚举值:

  • 5GB

  • 10GB

  • 20GB

refresh_interval

Long

实例的生命周期。 arm架构,生命周期只能设置成30,60。x86架构可取值为30,60,240,1440和-1。除-1外,其它值的单位为“分钟”。实例在到达生命周期后,将会被暂停(已保存的数据不会被删除)。-1表示实例不会自动停止。

region

String

区域

role

Role object

角色

role_id

String

角色id

server_map

Map<String,String>

server

server_url

String

服务链接

stack_id

String

技术栈ID,通过技术栈管理ListStacksByTag接口获取。

status

String

实例状态

枚举值:

  • INIT

  • STARTING

  • RUNNING

  • STOPPING

  • STOPPED

  • DELETING

  • DELETED

  • DELETE_FAILED

sub_org

String

子组织

updated_time

String

更新时间

表6 Attributes

参数

参数类型

描述

cpu_limit

String

cpu限制

memory_limit_bytes

String

内存限制

pvc_quantity

String

pvc规格

表7 Role

参数

参数类型

描述

c_role

String

子角色

id

String

id

role

String

角色

role_actionses

Array of RoleAction objects

角色执行操作列表

表8 RoleAction

参数

参数类型

描述

action_cname

String

动作名

actions

String

执行动作

枚举值:

  • CREATE_INSTANCE

  • DELETE_INSTANCE

  • UPDATE_INSTANCE

  • QUERY_INSTANCE

  • RUN_INSTANCE

  • CREATE_SUB_ORG

  • UPDATE_SUB_ORG

  • DELETE_SUB_ORG

  • QUERY_SUB_ORG

  • ADD_USER_TO_ORG

  • SET_USER_ROLES

  • DELETE_USER_IN_ORG

  • QUERY_USER_IN_ORG

id

String

id

role_id

String

角色id

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 406

表11 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

查询IDE实例列表

GET https://{endpoint}/v2/instances

响应示例

状态码: 200

OK

{
  "instances" : {
    "items_before" : 0,
    "size" : 10,
    "count" : 1,
    "items" : [ {
      "is_private" : false,
      "updated_time" : "2020-03-17 15:21:36",
      "private" : false,
      "role" : {
        "role" : "owner",
        "id" : "1"
      },
      "owner_id" : "0dc311a468024ad5bf18591c8361272a",
      "description" : "ddd",
      "cpu_memory" : "2U4G",
      "domain_name" : "devcloud_cloudide_pwx501764_g01",
      "role_id" : "1",
      "is_temporary" : false,
      "stack_id" : "java",
      "id" : "instancewrqztsgn12imjq7e",
      "created_time" : "2020-01-06 15:25:04",
      "owner_name" : "devcloud_cloudide_pwx501764_g01",
      "refresh_interval" : 30,
      "display_name" : "test001",
      "organization_id" : "6251b1ee539f4c02ad4b83daeda81633",
      "name" : "cloudide-instance4xceoej8vvpn32lx",
      "platform_id" : 1,
      "attributes" : {
        "cpu_limit" : "2",
        "pvc_quantity" : "5Gi",
        "memory_limit_bytes" : "4294967296"
      },
      "pvc_quantity" : "5GB",
      "arch" : "x86",
      "region" : "cn-north-7",
      "actions" : [ {
        "role_id" : "1",
        "action_cname" : "创建实例",
        "id" : "166",
        "actions" : "CREATE_INSTANCE"
      }, {
        "role_id" : "1",
        "action_cname" : "删除实例",
        "id" : "167",
        "actions" : "DELETE_INSTANCE"
      }, {
        "role_id" : "1",
        "action_cname" : "更新实例",
        "id" : "168",
        "actions" : "UPDATE_INSTANCE"
      }, {
        "role_id" : "1",
        "action_cname" : "查询实例列表",
        "id" : "169",
        "actions" : "QUERY_INSTANCE"
      }, {
        "role_id" : "1",
        "action_cname" : "运行实例",
        "id" : "170",
        "actions" : "RUN_INSTANCE"
      } ],
      "status" : "STOPPED"
    } ],
    "empty" : false
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品