调用StartDBInstance接口启动专属集群内的实例。

专属集群功能以集群形式批量管理实例,一个地域可以创建多个专属集群,一个专属集群包含多个主机,一个主机包含多个实例。详情请参见专属集群简介

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String StartDBInstance

系统规定参数,取值:StartDBInstance

DBInstanceId String rm-bpxxxxx

专属集群内的实例ID。

DedicatedHostGroupId String dhg-39xxxxxx

专属集群ID。您可以调用DescribeDedicatedHostGroups查询。

RegionId String cn-hangzhou

地域ID。可以通过接口DescribeRegions查看地域ID。

TargetDedicatedHostIdForMaster String dh-bpxxxxx

主节点的目标主机ID。

说明 DBInstanceTransType=2时需要传该本参数。
TargetDedicatedHostIdForSlave String dh-bpxxxxx

备节点的目标主机ID。

说明 DBInstanceTransType=2时需要传入该参数。
TargetDedicatedHostIdForLog String dh-bpxxxxx

日志节点的目标主机ID。

说明 当前此参数无效。
EffectiveTime String Immediate

生效时间,取值:

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

默认值:MaintainTime。

SpecifiedTime String 2019-10-21T10:00:00Z

指定切换的时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明EffectiveTime=Specified时需要填入本参数。
TargetDBInstanceClass String rds.ebmhfc6.20xlarge

目标实例的规格。

EngineVersion String 5.7

数据库版本。

DBInstanceTransType Integer 0

实例的迁移方式。取值:

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

自定义存储空间,取值:5~2000。单位:GB。不传该参数表示存储空间保持不变。

VSwitchId String vsw-xxxxxx

交换机ID。

ZoneId String cn-hangzhou-a

可用区ID。

返回数据

名称 类型 示例值 描述
MigrationId Integer 740

迁移任务ID。

RequestId String A417FB41-A3D9-464E-AD0A-C7FE05C72E98

请求ID。

TaskId Integer 238028563

任务ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=StartDBInstance
&DBInstanceId=rm-bpxxxxx
&DedicatedHostGroupId=dhg-39xxxxxx
&<公共请求参数>

正常返回示例

XML格式

<StartDBInstanceResponse>
    <MigrationId>740</MigrationId>
    <RequestId>A417FB41-A3D9-464E-AD0A-C7FE05C72E98</RequestId>
    <TaskId>238028563</TaskId>
</StartDBInstanceResponse>

JSON格式

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

错误码

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