Queries the CIDR blocks of Data Transmission Service (DTS) servers.

If the source or destination instance is a self-managed database or a third-party cloud database, you need to call this operation to query the CIDR blocks of DTS servers. Then, you need to add the CIDR blocks of DTS servers to the security settings of the source or destination instance, for example, the firewall of your database. For more information, see Add the CIDR blocks of DTS servers to the security settings of on-premises databases.

Note If the source or destination database is an ApsaraDB database instance (such as RDS instance and ApsaraDB for MongoDB instance) or a self-managed database hosted on Elastic Compute Service (ECS), you do not need to add the CIDR blocks. When you click Set Whitelist and Next in the DTS console, DTS automatically adds the CIDR blocks of DTS servers to the security settings of the source or destination instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes WhiteIpList

The operation that you want to perform. Set the value to WhiteIpList.

Region String Yes cn-hangzhou

The ID of the region where the source instance resides. For more information, see List of supported regions.

Note If the source instance is a self-managed database with a public IP address or a third-party cloud database, you can set the parameter to cn-hangzhou or the ID of the closest region.
Type String Yes vpc

Specifies how the self-managed database or third-party cloud database is connected to DTS. Valid values:

  • internet: The database is connected to DTS over the Internet.
  • vpc: The database is connected to DTS over Express Connect, VPN Gateway, or Smart Access Gateway
DestinationRegion String No cn-hangzhou

The ID of the region where the destination instance resides. For more information, see List of supported regions.

Note
  • If the destination instance is a self-managed database with a public IP address or a third-party cloud database, you can set the parameter to cn-hangzhou or the ID of the closest region.
  • If the DTS task is a data migration or data synchronization task, you must specify this parameter.

Response parameters

Parameter Type Example Description
DynamicCode String 403

The dynamic error code. This parameter will be removed in the future.

DynamicMessage String Type

The dynamic part in the error message. This parameter is used to replace %s in the ErrMessage parameter.

ErrCode String InternalError

The error code returned if the call failed.

ErrMessage String The Value of Input Parameter %s is not valid.

The error message returned if the call failed.

HttpStatusCode Integer 200

The HTTP status code.

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

The CIDR blocks of DTS servers. Multiple CIDR blocks are separated by commas (,).

RequestId String AD823BD3-1BA6-4117-A536-165CB280****

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=WhiteIpList
&Region=cn-hangzhou
&Type=vpc
&DestinationRegion=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

<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 format 

{
    "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"
}

Error codes

For a list of error codes, visit the API Error Center.