Domain name for API request: redis.tencentcloudapi.com.
This API is used to query the DTS task details of an instance.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeInstanceDTSInfo. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID |
| Parameter Name | Type | Description |
|---|---|---|
| JobId | String | DTS task ID Note: this field may return null, indicating that no valid values can be obtained. |
| JobName | String | DTS task name Note: this field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Task status. Valid values: 1 (Creating), 3 (Checking), 4 (CheckPass), 5 (CheckNotPass), 7 (Running), 8 (ReadyComplete), 9 (Success), 10 (Failed), 11 (Stopping), 12 (Completing) Note: this field may return null, indicating that no valid values can be obtained. |
| StatusDesc | String | Status description Note: this field may return null, indicating that no valid values can be obtained. |
| Offset | Integer | Synchronization latency in bytes Note: this field may return null, indicating that no valid values can be obtained. |
| CutDownTime | String | Disconnection time Note: this field may return null, indicating that no valid values can be obtained. |
| SrcInfo | DescribeInstanceDTSInstanceInfo | Source instance information Note: this field may return null, indicating that no valid values can be obtained. |
| DstInfo | DescribeInstanceDTSInstanceInfo | Target instance information Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://redis.tencentcloudapi.com/?Action=DescribeInstanceDTSInfo
&InstanceId=crs-6ia1c1c3
&<Common request parameters>{
"Response": {
"CutDownTime": "2019-08-16 17:10:13",
"DstInfo": {
"InstanceId": "crs-jufvqtt7",
"InstanceName": "dtsdsttest28",
"RegionId": 1,
"SetId": 15005,
"Status": 1,
"Type": 2,
"Vip": "172.16.16.48",
"ZoneId": 100002
},
"JobId": "dts-l2g434lt",
"JobName": "redis_dts_test28",
"Offset": 0,
"RequestId": "f5ff1c8e-7ea4-40a8-b179-8a99c6f7085b",
"SrcInfo": {
"InstanceId": "crs-6ia1c1c3",
"InstanceName": "dtsSrctest28",
"RegionId": 1,
"SetId": 15005,
"Status": -4,
"Type": 2,
"Vip": "172.16.16.9",
"ZoneId": 100002
},
"Status": 10,
"StatusDesc": "Failed"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.SystemError | Internal system error, which is irrelevant to the business. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
Was this page helpful?