首页 云数据库 RDS API参考 API目录 实例 StartDBInstance - 启动RDS实例

StartDBInstance - 启动RDS实例

该接口用于启动暂停的RDS实例。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:StartDBInstanceWrite
  • RDS
    acs:rds:*:{#accountId}:dbinstance/{#DBInstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。可调用DescribeRegions获取。

cn-hangzhou
DedicatedHostGroupIdstring

该接口也支持暂停专属集群下的RDS实例,此时需要配置专属集群ID。可调用DescribeDedicatedHostGroups查询。

dhg-39****
DBInstanceIdstring

实例ID。可调用DescribeDBInstances获取。

rm-bp****
TargetDedicatedHostIdForMasterstring

该参数仅支持专属集群实例,配置主节点的目标主机ID。

说明DBInstanceTransType=2时需要传该本参数。
dh-bp****
TargetDedicatedHostIdForSlavestring

该参数仅支持专属集群实例,配置备节点的目标主机ID。

说明DBInstanceTransType=2时需要传入该参数。
dh-bp****
TargetDedicatedHostIdForLogstring

此参数已废弃,无需配置。

dh-bp****
EffectiveTimestring

该参数仅支持专属集群实例,生效时间,取值:

  • Immediate:立即生效。
  • MaintainTime:在可运维时间段内生效,请参见ModifyDBInstanceMaintainTime
  • SpecificTime:指定时间生效。

默认值:MaintainTime。

Immediate
SpecifiedTimestring

该参数仅支持专属集群实例,指定切换的时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明EffectiveTime=Specified时需要填入本参数。
2019-10-21T10:00:00Z
TargetDBInstanceClassstring

该参数仅支持专属集群实例,目标实例的规格。

rds.ebmhfc6.20xlarge
EngineVersionstring

该参数仅支持专属集群实例,数据库版本。

5.7
DBInstanceTransTypeinteger

该参数仅支持专属集群实例,实例的迁移方式。取值:

  • 0:默认值。系统优先进行本地升降级,若本地资源不足,则进行跨机迁移。
  • 1:本地升降级。若系统判断实例当前不支持本地升降级,则会报错。
  • 2:跨机迁移。将实例迁移到指定的主机,需要传入参数DedicatedHostGroupIdTargetDedicatedHostIdForMasterTargetDedicatedHostIdForSlave。不能迁移到当前实例所在主机,否则会迁移失败。
0
Storageinteger

该参数仅支持专属集群实例,自定义存储空间,取值:5~2000。单位:GB。不传该参数表示存储空间保持不变。

1000
VSwitchIdstring

该参数仅支持专属集群实例,交换机ID。

vsw-****
ZoneIdstring

该参数仅支持专属集群实例,可用区ID。

cn-hangzhou-a

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

A417FB41-A3D9-464E-AD0A-C7FE05C72E98
TaskIdinteger

任务ID。

238028563
MigrationIdinteger

该参数仅支持专属集群实例,迁移任务ID。

740

示例

正常返回示例

JSON格式

{
  "RequestId": "A417FB41-A3D9-464E-AD0A-C7FE05C72E98",
  "TaskId": 238028563,
  "MigrationId": 740
}

错误码

HTTP status code错误码错误信息
400InvalidStatus.FormatSpecified Status is not valid

访问错误中心查看更多错误码。

阿里云首页 关系型数据库 相关技术圈