You can call the StartDBInstance operation to start an ApsaraDB RDS for MySQL instance or an instance that is created in a dedicated cluster.

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 StartDBInstance

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

RegionId String No cn-hangzhou

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

DedicatedHostGroupId String No dhg-39xxxxxx

The ID of the dedicated cluster to which the instance belongs. You can call the DescribeDedicatedHostGroups operation to query the ID of the dedicated cluster.

Note Only the instances that are created in dedicated clusters are supported.
DBInstanceId String Yes rm-bpxxxxx

The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

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.
  • Only the instances that are created in dedicated clusters are supported.
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.
  • Only the instances that are created in dedicated clusters are supported.
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 instance to be started. Valid values:

  • Immediate: The instance is immediately started.
  • MaintainTime: The instance is started during the maintenance window that you specified. For more information, see Modify the maintenance window.
  • SpecificTime: The instance is started at a specified point in time.

Default value: MaintainTime.

Note Only the instances that are created in dedicated clusters are supported.
SpecifiedTime String No 2019-10-21T10:00:00Z

The point in time when you want the instance to be started. 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 SpecificTime.
  • Only the instances that are created in dedicated clusters are supported.
TargetDBInstanceClass String No rds.ebmhfc6.20xlarge

The instance type of the instance.

Note Only the instances that are created in dedicated clusters are supported.
EngineVersion String No 5.7

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

Note Only the instances that are created in dedicated clusters are supported.
DBInstanceTransType Integer No 0

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

  • 0: 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.
Note Only the instances that are created in dedicated clusters are supported.
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.

Note Only the instances that are created in dedicated clusters are supported.
VSwitchId String No vsw-xxxxxx

The ID of the vSwitch.

Note Only the instances that are created in dedicated clusters are supported.
ZoneId String No cn-hangzhou-a

The ID of the zone to which the instance belongs.

Note Only the instances that are created in dedicated clusters are supported.

Response parameters

Parameter Type Example Description
RequestId String A417FB41-A3D9-464E-AD0A-C7FE05C72E98

The ID of the request.

TaskId Integer 238028563

The ID of the task.

MigrationId Integer 740

The ID of the migration task.

Note This parameter is returned only for the instances that are created in dedicated clusters.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

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