API文档
容器云相关接口
容器实例
关闭容器实例

1. 关闭容器实例

本接口用于关闭一台容器实例。

  1. 只有状态为 Running 的容器实例才可以进行此操作。
  2. 本接口暂未支持批量操作。
  3. 本接口为异步接口。当创建容器实例请求下发成功后会返回一个任务进度信息(jobUuid)。通过 jobUuid 可以查询出当前异步任务执行情况。如果异步任务正在执行,返回的内容里 done=false、success=false,并有进度值显示;如果异步任务执行成功完成,返回的内容里 done=true、success=true;如果异步任务执行失败,返回的内容里 done=true,success=false。

1.1. 接口说明

本接口所属服务类型为 ackcs

本接口操作类型为 StopServices

1.1.1. 请求路径

POST {baseUrl}/v3/ackcs/StopServices

1.1.2. 请求体

{
	"serviceUuids": ["ackcs-00x2qyak"],
	"stoppedMode": "STOP_CHARGING",
	"saveEnv": true,
	"zoneCode": "cn-zhongwei-ac"
}

请求体内容说明

属性名
属性类型
是否必须
默认值说明
zoneCodeString可用区编码
serviceUuidsArray需要关闭的容器实例列表
stoppedModeStringSTOP_CHARGING容器实例关机计费模式。取值范围 KEEP_CHARGING、STOP_CHARGING。按需容器实例默认为关机不计费 STOP_CHARGING;包月容器实例只支持关机计费KEEP_CHARGING
saveEnvBooleanfalse按需容器实例是否开启关机保存环境。为true保存环境,用户的文件和配置都会保留;否则,都会被删除

注意

  1. 按需计费的容器实例只支持关机不计费模式STOP_CHARGING
  2. 包月计费的容器实例只支持关机计费模式KEEP_CHARGING

关机计费模式在容器实例关机后不会释放 CPU、内存资源,不会出现由于资源不足导致的无法开机的情况

关机不计费模式在容器实例关机后会释放 CPU、内存资源,在资源不足的情况下会出现无法开机的情况

1.1.3. 返回内容

{
	"code": 200,
	"message": "关闭实例成功",
	"data": [{
		"jobUuid": "req-00001njdvy-00x2qyak",
		"resourceUuid": "ackcs-00x2qyak",
		"type": "Stop",
		"done": false,
		"success": false
	}]
}

返回内容说明

属性名属性类型说明
codeInteger返回码。正常返回 200,异常返回500或其他业务错误码
messageString返回信息
dataArray异步任务进度信息

异步任务进度信息

属性名属性类型说明
jobUuidString异步任务唯一编码
successBoolean异步任务是否执行成功
typeString异步任务类型
doneBoolean异步任务是否执行完成
resourceUuidString异步任务所处理的资源 Uuid