该接口用于启动暂停的RDS实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:StartDBInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID。可调用 DescribeRegions 获取。 | cn-hangzhou |
DedicatedHostGroupId | string | 否 | 该接口也支持暂停专属集群下的 RDS 实例,此时需要配置专属集群 ID。可调用 DescribeDedicatedHostGroups 查询。 | dhg-39**** |
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 获取。 | rm-bp**** |
TargetDedicatedHostIdForMaster | string | 否 | 该参数仅支持专属集群实例,配置主节点的目标主机 ID。 说明
DBInstanceTransType=2 时需要传该本参数。
| dh-bp**** |
TargetDedicatedHostIdForSlave | string | 否 | 该参数仅支持专属集群实例,配置备节点的目标主机 ID。 说明
DBInstanceTransType=2 时需要传入该参数。
| dh-bp**** |
TargetDedicatedHostIdForLog | string | 否 | 此参数已废弃,无需配置。 | dh-bp**** |
EffectiveTime | string | 否 | 该参数仅支持专属集群实例,生效时间,取值:
默认值:MaintainTime。 | Immediate |
SpecifiedTime | string | 否 | 该参数仅支持专属集群实例,指定切换的时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
当 EffectiveTime=Specified 时需要填入本参数。
| 2019-10-21T10:00:00Z |
TargetDBInstanceClass | string | 否 | 该参数仅支持专属集群实例,目标实例的规格。 | rds.ebmhfc6.20xlarge |
EngineVersion | string | 否 | 该参数仅支持专属集群实例,数据库版本。 | 5.7 |
DBInstanceTransType | integer | 否 | 该参数仅支持专属集群实例,实例的迁移方式。取值:
| 0 |
Storage | integer | 否 | 该参数仅支持专属集群实例,自定义存储空间,取值:5~2000。单位:GB。不传该参数表示存储空间保持不变。 | 1000 |
VSwitchId | string | 否 | 该参数仅支持专属集群实例,交换机 ID。 | vsw-**** |
ZoneId | string | 否 | 该参数仅支持专属集群实例,可用区 ID。 | cn-hangzhou-a |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "A417FB41-A3D9-464E-AD0A-C7FE05C72E98",
"TaskId": 238028563,
"MigrationId": 740
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidStatus.Format | Specified Status is not valid | - |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
访问错误中心查看更多错误码。