文档首页/ CodeArts IDE Online/ API参考/ 应用示例/ 示例2:查询IDE实例列表
更新时间:2023-12-18 GMT+08:00
分享

示例2:查询IDE实例列表

操作场景

用户通过查询IDE实例列表接口,使用分页参数查询租户下所有IDE实例列表。API的调用方法请参见如何调用API

本节示例操作包括分页查询,接口支持过滤和排序参数的操作,参数详情请参见查询IDE实例列表

前提条件

确定调用API的Endpoint,详细信息请参见终端节点

查询IDE实例列表

  1. 指定limit查询IDE实例列表。

    GET: https://{endpoint}/v2/instances?limit=10

    {
      "instances" : {
        "items_before" : 0,
        "size" : 10,
        "total_items_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_name_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"
    }
  2. 通过limit和关键字过滤查询实例。

    如:查询实例名称或描述中含test的实例列表。

    GET: https://{endpoint}/v2/instances?limit=10&search=test

相关文档