调用StartDBInstance接口启动主机组内的实例。
主机组功能以集群形式批量管理实例,一个地域创建多个主机组,一个主机组包含多个主机,一个主机包含多个实例。详情请参见主机组简介。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StartDBInstance |
系统规定参数,取值:StartDBInstance。 |
DBInstanceId | String | 是 | rm-bpxxxxx |
主机组内的实例ID。 |
DedicatedHostGroupId | String | 是 | dhg-39xxxxxx |
主机组ID。 |
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 |
生效时间,取值:
默认值: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 |
实例的迁移方式。取值:
|
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
}
错误码
访问错误中心查看更多错误码。