
# 停止备份 - StoppingaBackup
#### 功能介绍
支持紧急情况下停止备份功能。
#### 接口约束
- 目前仅支持GeminiDB Cassandra紧急情况下停止备份功能。
- 仅支持状态为备份中或备份上传中的实例。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ListConfigurations)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                 | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名                | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:stopBackup | write | -           | -   | nosql:backup:stop | -      |
     
  
 
#### URI
PUT /v3/{project_id}/backups/{backup_id}
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。               |
| backup_id  | 是    | String | **参数解释：** 备份文件ID。 获取方式请参见"[查询备份列表](https://support.huaweicloud.com/api-nosql/nosql_12_0011.html)"响应参数"backups"。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表3请求Body参数 
| 参数     | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| action | 是    | String | **参数解释：** 对备份执行的操作类型。 **约束限制：** 不涉及。 **取值范围：** stop：表示停止备份。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码： 202**
表4响应Body参数 
| 参数     | 参数类型   | 描述                                                                                                                               |
|:---|:---|:---|
| job_id | String | **参数解释：** 任务流ID。 **取值范围：** 不涉及。 |
   
#### 请求示例
```
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups/ca8cb4638f3d42bfa6e942464339be89br14 
 
{ 
  "action" : "stop" 
}
```
#### 响应示例
**状态码： 202**
Success
```
{ 
  "job_id":"b52cc59d-e1e2-4e63-bb00-7694e126f66a" 
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。
