保护组停止保护 - StopProtectionGroup
功能介绍
对某一个保护组的停止保护操作。
接口约束
保护组status为protected或者error-stopping才能停止保护。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/server-groups/{server_group_id}/action
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。 |
| server_group_id | 是 | String | 保护组的ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| stop-server-group | 是 | Object | 标识保护组停止保护操作。该参数目前默认值为空。 |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 成功返回jobId信息 |
状态码: 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
状态码: 401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 405
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 406
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 407
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 409
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 501
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 502
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 503
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 504
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
请求示例
POST https://{Endpoint}/v1/{project_id}/server-groups/40df180b-9fe2-471a-8c64-1b758dc84189/action
{
"stop-server-group" : { }
} 响应示例
状态码: 200
OK
{
"job_id" : "ff8080826adfae02016ae2d123fc05ed"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 407 | Proxy Authentication Required |
| 408 | Request Timeout |
| 409 | Conflict |
| 500 | Internal Server Error |
| 501 | Not Implemented |
| 502 | Bad Gateway |
| 503 | Service Unavailable |
| 504 | Gateway Timeout |
错误码
请参见错误码。