调用ClearDedicatedHost接口迁空RDS主机。

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

调试

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

请求参数

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

系统规定参数。取值:ClearDedicatedHost

DedicatedHostId String i-bpxxxxxxx

主机ID。

FailoverMode String MaintainTime

迁空主机方案。取值:

  • MaintainTime:在实例的可维护时间段内切换主备实例,待本主机所有实例全部是备实例后,再将备实例迁移走。
  • Immediate:立即将主机上主实例切换成备实例,然后再将备实例迁移走。
RegionId String cn-hangzhou

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

AccessKeyId String LTAIfCxxxxxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
DedicatedHostId String i-bpxxxxxxx

主机ID。

RequestId String C6F4A9ED-7C51-420F-A274-E97776C81C10

请求ID。

TaskId String 208670147

任务ID。

示例

请求示例


http(s)://rds.aliyuncs.com/?Action=ClearDedicatedHost
&DedicatedHostId=i-bpxxxxxxx
&FailoverMode=MaintainTime
&<公共请求参数>

正常返回示例

XML 格式

<ClearDedicatedHostResponse>
  <DedicatedHostId>i-bpxxxxxxx</DedicatedHostId>
  <RequestId>C6F4A9ED-7C51-420F-A274-E97776C81C10</RequestId>
  <TaskId>208670147</TaskId>
</ClearDedicatedHostResponse>

JSON 格式

{
	"DedicatedHostId":"i-bpxxxxxxx",
	"RequestId":"C6F4A9ED-7C51-420F-A274-E97776C81C10",
	"TaskId":208670147
}

错误码

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