接口約束
保護組status為protected或者error-stopping才能停止保護。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
POST /v1/{project_id}/server-groups/{server_group_id}/action
表1 路徑參數(shù)
|
參數(shù)
|
是否必選
|
參數(shù)類型
|
描述
|
|
project_id
|
是
|
String
|
項目ID。
|
|
server_group_id
|
是
|
String
|
保護組的ID。
|
請求參數(shù)
表3 請求Body參數(shù)
|
參數(shù)
|
是否必選
|
參數(shù)類型
|
描述
|
|
stop-server-group
|
是
|
Object
|
標識保護組停止保護操作。該參數(shù)目前默認值為空。
|
響應參數(shù)
狀態(tài)碼： 200
表4 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
job_id
|
String
|
成功返回jobId信息
|
狀態(tài)碼： 400
表5 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表6 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 401
表7 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表8 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 403
表9 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表10 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 404
表11 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表12 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 405
表13 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表14 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 406
表15 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表16 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 407
表17 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表18 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 408
表19 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表20 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 409
表21 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表22 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 500
表23 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表24 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 501
表25 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表26 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 502
表27 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表28 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 503
表29 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表30 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
狀態(tài)碼： 504
表31 響應Body參數(shù)
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
error
|
ErrorInfo object
|
失敗返回結(jié)構(gòu)
|
表32 ErrorInfo
|
參數(shù)
|
參數(shù)類型
|
描述
|
|
message
|
String
|
錯誤信息
|
|
code
|
String
|
錯誤碼
|
請求示例
POST https://{Endpoint}/v1/{project_id}/server-groups/40df180b-9fe2-471a-8c64-1b758dc84189/action
{
"stop-server-group" : { }
}
響應示例
狀態(tài)碼： 200
OK
{
"job_id" : "ff8080826adfae02016ae2d123fc05ed"
}
狀態(tài)碼
|
狀態(tài)碼
|
描述
|
|
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
|
