调用 ModifyDeletionProtection 接口,启停实例的删除保护功能。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyDeletionProtection | 要执行的操作,取值:ModifyDeletionProtection。 |
Version | String | 是 | 2023-01-01 | API的版本,取值:2023-01-01。 |
InstanceId | String | 是 |
| 需要启停删除保护功能的实例 ID |
DeletionProtection | Boolean | 是 |
| 是否开启实例删除保护功能。 说明 开启实例删除保护后,您将无法通过控制台或者 API 删除实例。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Status | String |
| 返回的操作状态。 |
Message | String |
| 返回的提示信息。 |
POST https://open.volcengineapi.com/?Action=ModifyDeletionProtection&Version=2023-01-01 Content-Type: application/json X-Date: 20231003T104027Z Authorization: HMAC-SHA256 Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b**** { "DeletionProtection": true, "InstanceId": "o-00k***o718" }
{ "ResponseMetadata": { "Action": "ModifyDeletionProtection", "Region": "cn-beijing", "RequestId": "202306041104200100100232**", "Service": "ESCloud", "Version": "2023-01-01" }, "Result": { "Message": "", "Status": "SUCCESSFUL" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
200 | InternalServerError | 服务由于异常退出,无法完成接口请求操作 |
200 | Unauthorized | 用户无权限调用接口 |
200 | IllegalParameter | 非法参数。可能是参数缺失,也可能是参数不符合接口要求 |