更新时间:2023-11-21 GMT+08:00

保护组停止保护

功能介绍

对某一个保护组的停止保护操作。

约束与限制

  • 保护组status为protected或者error-stopping才能停止保护。

URI

  • URI格式

    POST /v1/{project_id}/server-groups/{server_group_id}/action

  • 参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID。

    获取方法请参见获取项目ID

    server_group_id

    String

    保护组的ID。

    具体信息可参考查询保护组列表接口。

请求消息

  • 参数说明

    参数名称

    是否必选

    参数类型

    说明

    stop-server-group

    Object

    标识保护组停止保护操作。

    该参数目前默认值为空。

  • 请求样例
    POST https://{Endpoint}/v1/{project_id}/server-groups/40df180b-9fe2-471a-8c64-1b758dc84189/action
    {
        "stop-server-group": {}
    }

响应

  • 要素说明

    参数名称

    参数类型

    说明

    job_id

    String

    执行异步API命令下发成功的返回参数,任务执行结果请参考查询job状态接口。

  • 响应样例
    {
        "job_id": "ff8080826adfae02016ae2d123fc05ed"
    }

    { 
         "error": { 
             "message": "XXXX",  
             "code": "XXX" 
         } 
     }

    其中error是泛指的错误,有badrequest、itemNotFound等,如报错为:

    { 
         "badrequest": { 
             "message": "XXXX",  
             "code": "XXX" 
         } 
     }

返回值

  • 正常

    返回值

    说明

    200

    服务器已接受请求。

  • 异常

    返回值

    说明

    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

    网关超时。