调用WhiteIpList接口查询DTS服务器的IP地址。
如果源或目标实例是自建数据库或第三方云数据库,您需要调用该接口查询DTS服务的IP地址,然后将查询所得的IP地址添加至源或目标实例的安全设置(通常为该类数据库的防火墙)中。具体添加方式及更多信息,请参见迁移、同步或订阅本地数据库时需添加的IP白名单。
说明 如果源或目标数据库是阿里云数据库实例(例如RDS、MongoDB等)或ECS上的自建数据库,在配置源或目标实例信息时,如您点击授权白名单并进入下一步,系统会自动把DTS服务IP地址添加至实例的安全设置,您无需手动添加。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | WhiteIpList |
系统规定参数,取值:WhiteIpList。 |
Region | String | 是 | cn-hangzhou |
源实例所属地域ID,详情请参见支持的地域列表。 说明 如果源实例为有公网IP的自建数据库或第三方云数据库,则可以传入cn-hangzhou或者离该类数据库物理距离最近的区域ID。
|
Type | String | 是 | vpc |
自建数据库或第三方云数据库的接入方式,取值为
|
DestinationRegion | String | 否 | cn-hangzhou |
目标实例所属地域ID,详情请参见支持的地域列表。 说明
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DynamicCode | String | 403 |
动态错误码,本参数即将下线。 |
DynamicMessage | String | Type |
动态错误信息,用于替换返回参数ErrMessage错误信息中的%s。 |
ErrCode | String | InternalError |
调用出错时返回的错误码。 |
ErrMessage | String | The Value of Input Parameter %s is not valid. |
调用错误时返回的错误信息。 |
HttpStatusCode | Integer | 200 |
状态码。 |
IpList | String | 10.151.12.0/24,47.102.181.0/24,47.101.109.0/24,120.55.129.0/24,11.115.103.0/24,47.102.234.0/24 |
IP白名单列表,多个IP地址中间使用英文逗号(,)分隔。 |
RequestId | String | AD823BD3-1BA6-4117-A536-165CB280**** |
请求ID。 |
Success | Boolean | true |
请求是否成功,返回值:
|
示例
请求示例
http(s)://dts.aliyuncs.com/?Action=WhiteIpList
&Region=cn-hangzhou
&Type=vpc
&DestinationRegion=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<WhiteIpListResponse>
<RequestId>AD823BD3-1BA6-4117-A536-165CB280****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Success>true</Success>
<IpList>10.151.12.0/24,47.102.181.0/24,47.101.109.0/24,120.55.129.0/24,11.115.103.0/24,47.102.234.0/24</IpList>
</WhiteIpListResponse>
JSON
格式
{
"RequestId":"AD823BD3-1BA6-4117-A536-165CB280****",
"HttpStatusCode":200,
"Success":true,
"IpList": "10.151.12.0/24,47.102.181.0/24,47.101.109.0/24,120.55.129.0/24,11.115.103.0/24,47.102.234.0/24"
}
错误码
访问错误中心查看更多错误码。