You can call the StartDBInstance operation to start an instance that is created in a dedicated cluster.

Dedicated clusters allow you to manage a number of instances at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see What is ApsaraDB MyBase?

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes Start instance

The operation that you want to perform. Set the value to StartDBInstance.

DBInstanceId String Yes rm-bpxxxxx

The ID of the instance.

DedicatedHostGroupId String Yes dhg-39xxxxxx

The ID of the dedicated cluster. You can call the DescribeDedicatedHostGroups operation to query the IDs of dedicated clusters.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

TargetDedicatedHostIdForMaster String No dh-bpxxxxx

The ID of the host on which the primary instance is created.

Note This parameter must be specified when you set the DBInstanceTransType parameter to 2.
TargetDedicatedHostIdForSlave String No dh-bpxxxxx

The ID of the host on which the secondary instance is created.

Note This parameter must be specified when you set the DBInstanceTransType parameter to 2.
TargetDedicatedHostIdForLog String No dh-bpxxxxx

The ID of the host on which the logger instance is created.

Note This parameter is invalid.
EffectiveTime String No Immediate

The time when you want the specified settings to take effect. Valid values:

  • Immediate: The settings immediately take effect.
  • MaintainTime: The settings take effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
  • SpecificTime: The settings take effect at the specified point in time.

Default value: MaintainTime.

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

The point in time when you want the specified settings to take effect. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note This parameter must be specified when you set the EffectiveTime parameter to Specified.
TargetDBInstanceClass String No rds.ebmhfc6.20xlarge

The instance type of the instance.

EngineVersion String No 5.7

The version of the database engine that is run on the instance.

DBInstanceTransType Integer No 0

The policy based on which the system migrates the data of the instance. Valid values:

  • 0: This is the default value. The system preferentially upgrades or downgrades the instance without a migration. If the resources on the host on which the instance resides are insufficient, the system migrates the instance to another suitable host.
  • 1: The system upgrades or downgrades the instance without a migration. If the upgrade or downgrade is not supported, the system reports an error.
  • 2: The system migrates the data of the instance from the host on which the instance resides to another specified host. You must also specify the DedicatedHostGroupId, TargetDedicatedHostIdForMaster, and TargetDedicatedHostIdForSlave parameters. If you set the DBInstanceTransType parameter to 2, you cannot migrate the data of the instance to the host on which the instance resides. If you migrate the data of the instance to the host on which the instance resides, the migration fails.
Storage Integer No 1000

The storage capacity of the instance after the migration. Valid values: 5 to 2000. Unit: GB. If you do not specify this parameter, the storage capacity of the instance remains unchanged.

VSwitchId String No vsw-xxxxxx

The ID of the vSwitch to which the instance is connected.

ZoneId String No cn-hangzhou-a

The zone ID of the instance.

Response parameters

Parameter Type Example Description
MigrationId Integer 740

The ID of the migration task.

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

The ID of the request.

TaskId Integer 238028563

The ID of the task.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=StartDBInstance
&DBInstanceId=rm-bpxxxxx
&DedicatedHostGroupId=dhg-39xxxxxx
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.