調用WhiteIpList介面查詢DTS伺服器的IP地址。
如果源或目標執行個體是自建資料庫或第三方雲資料庫,您需要調用該介面查詢DTS服務的IP地址,然後將查詢所得的IP地址添加至源或目標執行個體的安全設定(通常為該類資料庫的防火牆)中。具體添加方式及更多資訊,請參見將DTS伺服器的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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。