查询用户所有DevServer实例列表
功能介绍
查询用户所有DevServer实例列表。
接口约束
暂无约束。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/dev-servers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。 约束限制：必填。 取值范围：1 - 64字符，字母、数字和中划线。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
owner |
否 |
String |
参数解释：实例归属的用户ID。 约束限制：可选。 取值范围：1 - 64字符，小写字母、数字和中划线。在大账号/有admin权限场景下生效，值通常为当前登录用户ID。 默认取值：不涉及。 |
|
sort_dir |
否 |
String |
参数解释：排序方式。 约束限制：可选。 取值范围：
默认取值：ASC。 |
|
sort_key |
否 |
String |
参数解释：排序字段。 约束限制：可选。 取值范围：
默认取值：createTime。 |
|
limit |
否 |
Integer |
参数解释：每一页的数量。 约束限制：可选。 取值范围：0 - 1024 默认取值：10。 |
|
offset |
否 |
Integer |
参数解释：分页记录的起始位置偏移量。 约束限制：可选。 取值范围：0 - 2147483647 默认取值：0。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
current |
Integer |
参数解释：当前页数。 取值范围：1 - 2097152 |
|
data |
Array of ServerResponse objects |
参数解释：DevServer实例列表。 |
|
pages |
Integer |
参数解释：总的页数。 取值范围：1 - 2097152 |
|
size |
Integer |
参数解释：每一页的数量。设置查询时每页返回的最大实例数量，此值将直接影响到返回数据的量。调整此值可以优化查询性能或提高单次请求的信息量。 取值范围：1 - 1024 |
|
total |
Long |
参数解释：总的记录数量。表示当前查询条件下，满足条件的实例总数。此字段用于用户了解数据的整体规模。 取值范围：1 - 2147483647 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_at |
Long |
参数解释：创建时间。 取值范围：不涉及。 |
|
update_at |
Long |
参数解释：更新时间。 取值范围：不涉及。 |
|
charging_mode |
String |
参数解释：计费模式。 取值范围：
|
|
cloud_server |
CloudServer object |
参数解释：云服务信息。 |
|
endpoints_response |
Array of Endpoints objects |
参数解释：实例私有IP信息。 |
|
flavor |
String |
参数解释：实例规格名称。 取值范围：^.{1,128}$。 |
|
id |
String |
参数解释：实例ID。 取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
key_pair_name |
String |
参数解释：密钥对名称。 取值范围：^[-_.a-zA-Z0-9]{1,64}$。 |
|
name |
String |
参数解释：实例名称。 取值范围：^[-_.a-zA-Z0-9]{1,64}$。 |
|
order_id |
String |
参数解释：订单ID。 取值范围：^[a-zA-Z0-9]{1,64}$。 |
|
server_image_response |
ServerImageResponse object |
参数解释：实例镜像信息。 取值范围：不涉及。 |
|
status |
String |
参数解释：实例状态。表示实例的当前运行状态，用于监控实例的生命周期和健康状况。 取值范围：
|
|
vpc_id |
String |
参数解释：实例所在虚拟私有云ID。 取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
endpoints |
Array of EndpointsRes objects |
参数解释：服务器私有IP信息。 |
|
image |
ServerImageResponse object |
参数解释：服务器镜像信息。 |
|
category |
String |
参数解释：服务器归属类型。 取值范围： |
|
server_hps |
ServerHpsInfo object |
参数解释：服务器归属超节点信息。 |
|
subnet_id |
String |
参数解释：实例所在子网的ID。 取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释：服务器资源id，或超节点子节点id。 取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
type |
String |
参数解释：DevServer服务器类型。 取值范围：
|
|
hps_id |
String |
参数解释：服务器所属的超节点资源id。 取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
hps_ecs_id |
String |
参数解释：超节点子节点对应服务器资源id。 取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
allowed_access_ips |
Array of strings |
参数解释：允许通过SSH协议访问Notebook的公网IP地址白名单列表。默认情况下，所有IP都可以访问。配置指定IP后，则仅允许指定IP所在的客户端访问。 约束限制：不涉及。 取值范围：0 - 1024个IP地址 默认取值：不涉及。 |
|
dev_service |
String |
参数解释：支持的服务。 取值范围：
|
|
extensions |
Map<String,String> |
参数解释：通过应用专属URL直接打开应用进入远程开发模式。包含应用的各种扩展配置。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
ssh_keys |
Array of strings |
参数解释：SSH密钥对名称列表。允许设置多个密钥对实现同时对SSH实例的访问。 约束限制：不涉及。 取值范围：0 - 1024个密钥对 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
allowed_access_ips |
Array of strings |
参数解释：允许通过SSH协议访问Notebook的公网IP地址白名单列表，默认都可以访问。当配置指定IP后，则仅允许IP所在的客户端实现对Notebook的访问。 |
|
dev_service |
String |
参数解释：访问Notebook的途径。 取值范围：枚举类型，取值如下：
|
|
ssh_keys |
Array of strings |
参数解释：SSH密钥对名称列表，允许设置多个密钥对实现同时对SSH实例的访问。 |
|
service |
String |
参数解释：访问Notebook的途径。 取值范围：枚举类型，取值如下：
|
|
uri |
String |
参数解释：实例私有IP地址。 取值范围：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
arch |
String |
参数解释：服务器镜像架构类型。 取值范围：
|
|
image_id |
String |
参数解释：服务器镜像ID。 取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
name |
String |
参数解释：服务器镜像名称。表示服务器镜像的名称。 约束限制：不涉及。 取值范围：1 - 256字符 默认取值：不涉及。 |
|
server_type |
String |
参数解释：服务器类型。 取值范围：
|
|
status |
String |
参数解释：服务器镜像状态。 取值范围：
|
请求示例
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 |
错误码
请参见错误码。
