接口功能介绍
根据实例id来暂停RDS实例。
接口约束
无
URI
POST /v1/open-api/instance/stop-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例id | eddf4d2c6d67407ba39e3453ee0776ca |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
returnObj | 否 | Object | 返回对象 | ||
message | 否 | String | 结果信息 | success |
请求示例
请求头header
无
请求体body
{
"outerProdInstId": "eddf4d2c6d67407ba39e3453ee0776ca"
}
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": null
}
状态码
状态码 | 描述 |
---|---|
0 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败, 失败原因见message |