关闭PG实例 - StopUPgSQLInstance
简介
关闭PG实例
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | string | 对应的 API 指令名称，当前 API 为 StopUPgSQLInstance | Yes |
| PublicKey | string | 用户公钥，可从 控制台 获取 | Yes |
| Signature | string | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | Yes |
请求参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Region | string | 地域。 参见 地域和可用区列表 | Yes |
| Zone | string | 可用区。参见 可用区列表 | Yes |
| ProjectId | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口 | No |
| InstanceID | string | 实例ID | Yes |
| StopHost | boolean | 是否将主机一并关闭 | No |
| ForceToStop | boolean | 是否强制关闭 | No |
响应字段
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | int | 返回状态码，为 0 则为成功返回，非 0 为失败 | Yes |
| Action | string | 操作指令名称 | Yes |
| Message | string | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | No |
示例
请求示例
https://api.an-link.com/?Action=StopUPgSQLInstance
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=fpPRgcuZ
&InstanceID=zKYhCZMD
&StopHost=true
&ForceToStop=true响应示例
{
"Action": "StopUPgSQLInstanceResponse",
"Message": "OhuFzevx",
"RetCode": 0
}