该接口用于暂停RDS实例。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
相关功能文档
注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:StopDBInstance | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-bp1q915x50h**** |
| RegionId | string | 是 | 地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "A417FB41-A3D9-464E-AD0A-C7FE05C72E98"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidStatus.Format | Specified Status is not valid | - |
| 400 | EngineNotSupported | The engine does not support the operation. | 当前引擎不支持此操作。 |
| 400 | ReadOnlyInstanceNotSupport | Specified ReadOnly Instance not support this operation. | 操作失败，只读实例不支持此操作。 |
| 400 | InvalidShareInstance.NotSupport | The share dbInstance is not support. | 共享型实例不支持 |
| 400 | ReadonlyInstanceNotSupport | The operation is not permitted due to type of the instance. | 指定的只读实例不支持此操作。 |
| 400 | InstanceHasReadOnlyInstanceNotSupportStop | The instance has read-only instance , stop is not supported | 实例有只读实例，不支持暂停实例 |
访问错误中心查看更多错误码。