停止DevServer超节点服务器
功能介绍
停止DevServer超节点服务器。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v1/{project_id}/dev-servers/hyperinstance/{id}/stop
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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}$。 默认取值:不涉及。 |
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
链路追踪编号 |
参数 |
参数类型 |
描述 |
---|---|---|
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信息。 |
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 |
参数解释:服务器镜像状态。 取值范围:
|
请求示例
POST https://{endpoint}/v1/{project_id}/dev-servers/hyperinstance/{id}/stop
响应示例
状态码:200
OK
{ "create_at" : 1737100086697, "hps_cluster_id" : "6fba954e-0d5e-4abf-9d54-f344d1de4eaa", "hps_id" : "451163c7-1f69-45e3-b6fa-b0dbee766767", "id" : "b41f61ed-fc38-4a84-a65c-35dae14acbc0", "name" : "devserver-hps-60b2", "order_id" : "CS2501171547LQEI9", "servers" : [ { "category" : "HPS", "charging_mode" : "PRE_PAID", "cloud_server" : { "hps_id" : "451163c7-1f69-45e3-b6fa-b0dbee766767", "id" : "5ed6f141-4872-481b-b917-16b6c7b9366c", "type" : "HPS" }, "create_at" : 1737100086698, "endpoints" : [ { "uri" : "10.1.0.76" } ], "flavor" : "kat3ne-16.96xlarge.8.800t.matrix-kf", "id" : "be6c8c8a-0322-4e90-9f51-f3639462aa87", "image" : { "image_id" : "59e58c02-8c52-42eb-87a9-3eb0a14d3343" }, "key_pair_name" : "KeyPair-de42", "name" : "devserver-hps-60b2-2", "order_id" : "CS2501171547LQEI9", "server_hps" : { "id" : "b41f61ed-fc38-4a84-a65c-35dae14acbc0", "name" : "devserver-hps-60b2" }, "status" : "STOPPING", "subnet_id" : "018a995b-29af-4140-b396-939d9c80a92b", "update_at" : 1737342598459, "vpc_id" : "7980ccf4-44d0-42cc-a844-42e035379a38" }, { "category" : "HPS", "charging_mode" : "PRE_PAID", "cloud_server" : { "hps_id" : "451163c7-1f69-45e3-b6fa-b0dbee766767", "id" : "cb8f5e9d-85b0-4cd7-ad30-cd06f05f5869", "type" : "HPS" }, "create_at" : 1737100086697, "endpoints" : [ { "uri" : "10.1.0.64" } ], "flavor" : "kat3ne-16.96xlarge.8.800t.matrix-kf", "id" : "24988d23-a7d9-4210-bba4-e945a4c2cf28", "image" : { "image_id" : "59e58c02-8c52-42eb-87a9-3eb0a14d3343" }, "key_pair_name" : "KeyPair-de42", "name" : "devserver-hps-60b2-1", "order_id" : "CS2501171547LQEI9", "server_hps" : { "id" : "b41f61ed-fc38-4a84-a65c-35dae14acbc0", "name" : "devserver-hps-60b2" }, "status" : "STOPPING", "subnet_id" : "018a995b-29af-4140-b396-939d9c80a92b", "update_at" : 1737193168118, "vpc_id" : "7980ccf4-44d0-42cc-a844-42e035379a38" } ], "status" : "ACTIVE", "update_at" : 1737185971586 }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。