Queries the CIDR blocks of DTS servers.

If the source or destination instance is an on-premises 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 ECS, you do not need to add the CIDR blocks. When you click Set Whitelist and Next in the DTS console, DTS automatically add 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 dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDTSIP

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

SourceEndpointRegion 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, you can set the parameter to cn-hangzhou or the ID of the closest region.
RegionId String No cn-hangzhou

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

DestinationEndpointRegion 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, you can set the parameter to cn-hangzhou or the ID of the closest region.

Response parameters

Parameter Type Example Description
DynamicCode String 500

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

DynamicMessage 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.

ErrCode String InternalError

The error code returned if the call failed.

ErrMessage String The request processing has failed due to some unknown error.

The error message returned if the call failed.

RequestId String 0C99C0BE-F312-40FA-ADFA-4DC1166B****

The ID of the request.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeDTSIP
&SourceEndpointRegion=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

<DescribeDTSIPResponse>
      <RequestId>0C99C0BE-F312-40FA-ADFA-4DC1166B****</RequestId>
      <DynamicMessage>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</DynamicMessage>
      <ErrMessage></ErrMessage>
      <Success>true</Success>
      <ErrCode></ErrCode>
</DescribeDTSIPResponse>

JSON format 

{
    "RequestId": "0C99C0BE-F312-40FA-ADFA-4DC1166B****",
    "DynamicMessage": "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",
    "ErrMessage": "",
    "Success": true,
    "ErrCode": ""
}

Error codes

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