文档首页/ AI开发平台ModelArts/ API参考/ DevServer管理/ 查询用户所有DevServer实例列表
更新时间:2024-05-30 GMT+08:00

查询用户所有DevServer实例列表

功能介绍

查询用户所有DevServer实例列表。

接口约束

暂无约束。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/dev-servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户项目ID,获取方法请参见获取项目ID和名称

表2 Query参数

参数

是否必选

参数类型

描述

owner

String

实例归属的用户ID,长度位32位小写字母、数字,在大账号/有admin权限场景下生效,值通常为当前登录用户ID。

sort_dir

String

排序方式。枚举值如下:

  • ASC升序。

  • DESC降序。

sort_key

String

排序字段,枚举值如下:

  • createTime:默认值,创建时间。

  • updateTime:更新时间。

limit

Integer

每一页的数量。

offset

Integer

分页记录的起始位置偏移量。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

current

Integer

当前页数。

data

Array of ServerResponse objects

DevServer实例列表。

pages

Integer

总的页数。

size

Integer

每一页的数量。

total

Long

总的记录数量。

表4 ServerResponse

参数

参数类型

描述

create_at

Long

创建时间。

update_at

Long

更新时间。

charging_mode

String

计费模式。

  • COMMON:同时支持包周期和按需;

  • POST_PAID:按需模式;

  • PRE_PAID:包周期。

cloud_server

CloudServer object

云服务信息。

endpoints_response

Array of Endpoints objects

实例私有IP信息。

flavor

String

实例规格名称。

id

String

实例ID。

key_pair_name

String

密钥对名称。

name

String

实例名称。

order_id

String

订单ID。

server_image_response

ServerImageResponse object

实例镜像信息。

status

String

实例状态。

  • CREATE_FAILED:创建失败;

  • CREATING:创建中;

  • DELETED:已删除;

  • DELETE_FAILED:删除失败;

  • DELETING:删除中;

  • ERROR:错误;

  • RUNNING:运行中;

  • STARTING:启动中;

  • START_FAILED:启动失败;

  • STOPPED:已停止;

  • STOPPING:停止中;

  • STOP_FAILED:停止失败。

vpc_id

String

实例所在虚拟私有云ID。

endpoints

Array of EndpointsRes objects

服务器的私有IP信息。

image

ServerImageResponse object

服务器镜像信息。

表5 CloudServer

参数

参数类型

描述

id

String

服务器资源id。

type

String

DevServer服务器类型。枚举值如下:

  • BMS:裸金属服务器

  • ECS:弹性云服务器

表6 Endpoints

参数

参数类型

描述

allowed_access_ips

Array of strings

允许通过SSH协议访问Notebook的公网IP地址白名单列表,默认都可以访问。当配置指定IP后,则仅允许IP所在的客户端实现对Notebook的访问。

dev_service

String

支持的服务,枚举值如下:

  • NOTEBOOK:可以通过https协议访问Notebook

  • SSH:可以通过SSH协议远程连接Notebook

  • AI_FLOW

  • MA_STUDIO

  • TENSOR_BOARD

  • WEB_IDE

extensions

Map<String,String>

通过应用专属URL直接打开应用进入远程开发模式。

ssh_keys

Array of strings

SSH密钥对名称列表,允许设置多个密钥对实现同时对SSH实例的访问。

表7 EndpointsRes

参数

参数类型

描述

allowed_access_ips

Array of strings

允许通过SSH协议访问Notebook的公网IP地址白名单列表,默认都可以访问。当配置指定IP后,则仅允许IP所在的客户端实现对Notebook的访问。

dev_service

String

支持的服务,枚举值如下:

  • NOTEBOOK:可以通过https协议访问Notebook。

  • SSH:可以通过SSH协议远程连接Notebook。

ssh_keys

Array of strings

SSH密钥对名称列表,允许设置多个密钥对实现同时对SSH实例的访问。

service

String

支持的服务,枚举值如下:

  • NOTEBOOK:可以通过https协议访问Notebook。

  • SSH:可以通过SSH协议远程连接Notebook。

uri

String

实例私有IP地址。

表8 ServerImageResponse

参数

参数类型

描述

arch

String

服务器镜像架构类型。

  • ARM

  • X86

image_id

String

服务器镜像ID。

name

String

服务器镜像名称。

server_type

String

服务器类型。枚举值如下:

  • BMS:裸金属服务器

  • ECS:弹性云服务器

请求示例

GET https://{endpoint}/v1/{project_id}/dev-servers

响应示例

状态码: 200

OK

{
  "current" : 0,
  "data" : [ {
    "charging_mode" : "POST_PAID",
    "cloud_server" : {
      "id" : "eb8b4e32-afc9-4f71-8372-1f55f3d7ab28",
      "type" : "ECS"
    },
    "create_at" : 1699352013484,
    "endpoints" : [ {
      "service" : "SSH",
      "uri" : "192.168.0.23"
    } ],
    "flavor" : "Si2.large.4",
    "id" : "c65c4f27-f791-452b-9098-a2726fa2e922",
    "image" : {
      "arch" : "X86",
      "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7",
      "name" : "Ubuntu18.04_x86_64_CPU",
      "server_type" : "ECS"
    },
    "name" : "EI-evs-01",
    "status" : "RUNNING",
    "update_at" : 1699352058465,
    "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172"
  }, {
    "charging_mode" : "POST_PAID",
    "cloud_server" : {
      "type" : "ECS"
    },
    "create_at" : 1699348284990,
    "flavor" : "Si2.large.4",
    "id" : "62383738-e52a-450a-9f84-f9e705402be8",
    "image" : {
      "arch" : "X86",
      "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7",
      "name" : "Ubuntu18.04_x86_64_CPU",
      "server_type" : "ECS"
    },
    "name" : "EI-evs-1107",
    "status" : "CREATING",
    "update_at" : 1699348285077
  } ],
  "pages" : 1,
  "size" : 2,
  "total" : 2
}

状态码

状态码

描述

200

OK

错误码

请参见错误码