重启实例或清空数据
功能介绍
重启运行中的DCS缓存实例。
清空Redis4.0及以上版本的实例数据,数据清空后,无法撤销,且无法恢复,请谨慎操作。
URI
PUT /v2/{project_id}/instances/status
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| instances | 否 | Array of strings | 参数解释: 实例的ID列表。可通过DCS控制台进入实例详情界面查看,或调用查询所有实例列表接口,获取响应参数instance_id的返回值。 |
| action | 否 | String | 参数解释: 对实例的操作。 约束限制: 当前版本,只有Redis 4.0及以上实例支持清空数据功能,即flush操作。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| results | Array of BatchOpsResult objects | 参数解释: 删除/重启/清空实例的结果。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 参数解释: 操作结果。 取值范围: success:删除/重启/清空实例成功。 failed:删除/重启/清空实例失败。 |
| instance | String | 参数解释: 缓存实例ID。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| error_code | String | 参数解释: 错误码。 取值范围: 请参见错误码。 |
| error_ext_msg | String | 参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| error_code | String | 参数解释: 错误码。 取值范围: 请参见错误码。 |
| error_ext_msg | String | 参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
请求示例
强制重启缓存实例。
PUT https://{dcs_endpoint}/v2/{project_id}/instances/status
{
"instances" : [ "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" ],
"action" : "restart"
} 响应示例
状态码:200
参数解释:
重启实例或清除实例数据成功。
{
"results" : [ {
"instance" : "e3a7019c-8824-4c1a-8289-5300f19b9f64",
"result" : "success"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 参数解释: 重启实例或清除实例数据成功。 |
| 400 | 非法请求。 |
| 500 | 内部服务错误。 |
错误码
请参见错误码。