StartDBInstance - ApsaraDB RDS - Alibaba Cloud Documentation Center

Starts an instance in a dedicated cluster.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:StartDBInstance	Write	RDS acs:rds:*:{#accountId}:dbinstance/{#DBInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DedicatedHostGroupId	string	No	The ID of the dedicated cluster. You can call the DescribeDedicatedHostGroups operation to query the ID of the dedicated cluster. NoteOnly the instances that are created in dedicated clusters are supported.	dhg-39****
DBInstanceId	string	Yes	The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.	rm-bp****
TargetDedicatedHostIdForMaster	string	No	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.	dh-bp****
TargetDedicatedHostIdForSlave	string	No	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.	dh-bp****
TargetDedicatedHostIdForLog	string	No	The ID of the host on which the logger instance is created. Note This parameter is invalid.	dh-bp****
EffectiveTime	string	No	The time at which you want the change to take effect. Valid values: Immediate: The change immediately takes effect. MaintainTime: The change takes effect during the maintenance window that you specified. For more information, see ModifyDBInstanceMaintainTime. SpecificTime: The change takes effect at a specified point in time. Default value: MaintainTime. NoteOnly the instances that are created in dedicated clusters are supported.	Immediate
SpecifiedTime	string	No	The custom time at which you want the change 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. Only the instances that are created in dedicated clusters are supported.	2019-10-21T10:00:00Z
TargetDBInstanceClass	string	No	The instance type of the instance. NoteOnly the instances that are created in dedicated clusters are supported.	rds.ebmhfc6.20xlarge
EngineVersion	string	No	The database engine version of the instance. NoteOnly the instances that are created in dedicated clusters are supported.	5.7
DBInstanceTransType	integer	No	The policy based on which the system migrates the data of the instance. Valid values: 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 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. NoteOnly the instances that are created in dedicated clusters are supported.	0
Storage	integer	No	The storage capacity of the instance. Valid values: 5 to 2000. Unit: GB. If you do not specify this parameter, the storage capacity of the instance remains unchanged. NoteOnly the instances that are created in dedicated clusters are supported.	1000
VSwitchId	string	No	The ID of the vSwitch. NoteOnly the instances that are created in dedicated clusters are supported.	vsw-****
ZoneId	string	No	The zone ID of the instance. NoteOnly the instances that are created in dedicated clusters are supported.	cn-hangzhou-a

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	A417FB41-A3D9-464E-AD0A-C7FE05C72E98
TaskId	integer	The ID of the task.	238028563
MigrationId	integer	The ID of the migration task. NoteThis parameter is returned only for the instances that are created in dedicated clusters.	740

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	InvalidStatus.Format	Specified Status is not valid

For a list of error codes, visit the Service error codes.