查询租户Hyperinstance列表
功能介绍
查询租户Hyperinstance列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/dev-servers/hyperinstance/all
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
current |
Integer |
参数解释:当前页数。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
data |
Array of ServerHyperinstanceResponse objects |
参数解释:DevServer超节点实例列表。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
pages |
Integer |
参数解释:总的页数。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
size |
Integer |
参数解释:每一页的数量。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
total |
Long |
参数解释:总的记录数量。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_at |
Long |
参数解释:创建时间。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
hps_cluster_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_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 |
参数解释:DevServer超节点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 |
参数解释:实例名称。 约束限制:不涉及。 取值范围:^[-_.a-zA-Z0-9]{1,64}$。 默认取值:不涉及。 |
|
order_id |
String |
参数解释:订单ID。 约束限制:不涉及。 取值范围:^[a-zA-Z0-9]{1,64}$。 默认取值:不涉及。 |
|
status |
String |
参数解释:超节点实例状态。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
|
servers |
Array of ServerResponse objects |
参数解释:超节点子节点实例列表。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
update_at |
Long |
参数解释:创建时间。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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信息。 |
|
volumes |
Array of ServerVolume objects |
参数解释:挂载硬盘信息。 |
|
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地址。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
参数解释:EVS盘大小。表示分配给系统盘的存储空间大小。 约束限制:不涉及。 取值范围:100 - 1024 GB 默认取值:不涉及。 |
|
type |
String |
参数解释:存储类型。表示系统盘或数据盘。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
|
evs_type |
String |
参数解释:EVS盘类型。表示EVS盘的存储类型。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
|
evs_id |
String |
参数解释:EVS盘的ID。 取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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/hyperinstance/all
响应示例
状态码:200
参数解释:超节点列表。
{
"current" : 0,
"data" : [ {
"create_at" : 1731055875839,
"hps_cluster_id" : "42669b79-da2f-4482-ad40-22f50442c9e7",
"hps_id" : "33806b62-1c7b-4781-8d2c-411a042b86b8",
"id" : "b4beacb6-4380-448c-a218-daa82cf03f5d",
"name" : "devserver-hps",
"order_id" : "CS2411081650G9B6Z",
"servers" : [ {
"charging_mode" : "PRE_PAID",
"cloud_server" : {
"hps_id" : "33806b62-1c7b-4781-8d2c-411a042b86b8",
"id" : "50208d41-749e-4bce-95a9-47a850925d4e",
"type" : "HPS"
},
"create_at" : 1731055875840,
"endpoints" : [ {
"service" : "SSH",
"uri" : "10.1.0.98"
} ],
"flavor" : "kat3ne-8.48xlarge.8.800t.matrix",
"id" : "278d70a9-2049-450a-bf6d-db02fe9f6634",
"image" : {
"image_id" : "86496e41-87c4-4779-9007-4f8f5c2a208f"
},
"key_pair_name" : "KeyPair-hps",
"name" : "devserver-hps-1",
"order_id" : "CS2411081650G9B6Z",
"server_hps" : {
"id" : "b4beacb6-4380-448c-a218-daa82cf03f5d",
"name" : "devserver-hps"
},
"status" : "RUNNING",
"update_at" : 1731209918651,
"vpc_id" : "7980ccf4-44d0-42cc-a844-42e035379a38"
} ],
"status" : "ACTIVE",
"update_at" : 1731209918651
} ],
"pages" : 1,
"size" : 10,
"total" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
参数解释:超节点列表。 |
错误码
请参见错误码。