- Release Notes and Announcements
- Release Notes
- Announcements
- Announcement on Changing External Network Links
- Interface Authentication Upgrade Announcement
- Maintenance Time Change from Local Time to Beijing Time
- Account Type and Permission Changes
- Product Architecture Name Change
- Disk Storage Space Composition Change
- Ending Support for Classic Network [2022.12.31]
- Backup Billing Start [2022.07.10]
- Ending Sale for Basic Edition 1-Core Specification [2022.03.07]
- User Guide
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Constraints and Limits
- Usage Specifications and Suggestions
- Maintaining Instance
- Renaming Instance
- Setting Instance Remarks
- Setting Instance Tag
- Setting Instance Project
- Modify Instance-level Character Set Collation
- Modify System Time Zone
- Setting Instance Maintenance Information
- Multi-AZ Disaster Recovery
- Restarting Instance
- Terminating Instance
- Migrating Across AZs
- Manual Primary-Secondary Switching
- Recycle Bin
- Adjusting Instance Configuration
- Read-Only Instance
- Network and Security
- Account Management
- Database Management
- Data Security
- Parameter Configuration
- Monitoring and Alarms
- Backup and Restoration
- Log Management
- Publish-Subscribe
- SSIS
- Data Migration (New)
- Data Migration (Legacy)
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Sales and fee related APIs
- Network management related APIs
- Account management related APIs
- Instance Management APIs
- Data security encryption related APIs
- Parameter configuration related APIs
- Log management related APIs
- Extended Event APIs
- Read only instance management related APIs
- Backup APIs
- Rollback APIs
- Data migration (cold standby migration) related APIs
- CreateBackupMigration
- ModifyBackupMigration
- StartBackupMigration
- DescribeBackupMigration
- DeleteBackupMigration
- DescribeUploadBackupInfo
- CreateIncrementalMigration
- ModifyIncrementalMigration
- StartIncrementalMigration
- DescribeIncrementalMigration
- DescribeBackupCommand
- DescribeBackupUploadSize
- DeleteIncrementalMigration
- Data migration (DTS old version) related APIs
- Making API Requests
- Database APIs
- Other APIs
- Data Types
- Error Codes
- FAQs
- Overview
- Model Selection
- Pricing and Selection
- Connection and Network
- Account and Permission
- Backup and Rollback
- Data Migration
- Publish/Subscribe
- Read-Only Instance
- Version and Architecture Upgrade
- Disk Space and Specification Adjustment
- Monitoring and Alarms
- Log
- Parameter Modification
- Features
- Performance/Space/Memory
- Service Agreement
- Performance Evaluation
- Glossary
- Contact Us
- Release Notes and Announcements
- Release Notes
- Announcements
- Announcement on Changing External Network Links
- Interface Authentication Upgrade Announcement
- Maintenance Time Change from Local Time to Beijing Time
- Account Type and Permission Changes
- Product Architecture Name Change
- Disk Storage Space Composition Change
- Ending Support for Classic Network [2022.12.31]
- Backup Billing Start [2022.07.10]
- Ending Sale for Basic Edition 1-Core Specification [2022.03.07]
- User Guide
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Constraints and Limits
- Usage Specifications and Suggestions
- Maintaining Instance
- Renaming Instance
- Setting Instance Remarks
- Setting Instance Tag
- Setting Instance Project
- Modify Instance-level Character Set Collation
- Modify System Time Zone
- Setting Instance Maintenance Information
- Multi-AZ Disaster Recovery
- Restarting Instance
- Terminating Instance
- Migrating Across AZs
- Manual Primary-Secondary Switching
- Recycle Bin
- Adjusting Instance Configuration
- Read-Only Instance
- Network and Security
- Account Management
- Database Management
- Data Security
- Parameter Configuration
- Monitoring and Alarms
- Backup and Restoration
- Log Management
- Publish-Subscribe
- SSIS
- Data Migration (New)
- Data Migration (Legacy)
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Sales and fee related APIs
- Network management related APIs
- Account management related APIs
- Instance Management APIs
- Data security encryption related APIs
- Parameter configuration related APIs
- Log management related APIs
- Extended Event APIs
- Read only instance management related APIs
- Backup APIs
- Rollback APIs
- Data migration (cold standby migration) related APIs
- CreateBackupMigration
- ModifyBackupMigration
- StartBackupMigration
- DescribeBackupMigration
- DeleteBackupMigration
- DescribeUploadBackupInfo
- CreateIncrementalMigration
- ModifyIncrementalMigration
- StartIncrementalMigration
- DescribeIncrementalMigration
- DescribeBackupCommand
- DescribeBackupUploadSize
- DeleteIncrementalMigration
- Data migration (DTS old version) related APIs
- Making API Requests
- Database APIs
- Other APIs
- Data Types
- Error Codes
- FAQs
- Overview
- Model Selection
- Pricing and Selection
- Connection and Network
- Account and Permission
- Backup and Rollback
- Data Migration
- Publish/Subscribe
- Read-Only Instance
- Version and Architecture Upgrade
- Disk Space and Specification Adjustment
- Monitoring and Alarms
- Log
- Parameter Modification
- Features
- Performance/Space/Memory
- Service Agreement
- Performance Evaluation
- Glossary
- Contact Us
1. API Description
Domain name for API request: sqlserver.intl.tencentcloudapi.com.
This API is used to modify an existing migration task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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 Params. The value used for this API: ModifyMigration. |
| Version | Yes | String | Common Params. The value used for this API: 2018-03-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| MigrateId | Yes | Integer | Migration task ID |
| MigrateName | No | String | New name of migration task. If this parameter is left empty, no modification will be made |
| MigrateType | No | Integer | New migration type (1: structure migration, 2: data migration, 3: incremental sync). If this parameter is left empty, no modification will be made |
| SourceType | No | Integer | Migration source type. 1: TencentDB for SQL Server, 2: CVM-based self-created SQL Server database; 3: SQL Server backup restoration, 4: SQL Server backup restoration (in COS mode). If this parameter is left empty, no modification will be made |
| Source | No | MigrateSource | Migration source. If this parameter is left empty, no modification will be made |
| Target | No | MigrateTarget | Migration target. If this parameter is left empty, no modification will be made |
| MigrateDBSet.N | No | Array of MigrateDB | Database objects to be migrated. This parameter is not used for offline migration (SourceType=4 or SourceType=5). If it left empty, no modification will be made |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| MigrateId | Integer | Migration task ID |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Modifying a migration task
Input Example
https://sqlserver.intl.tencentcloudapi.com/?Action=ModifyMigration
&MigrateId=2728
&MigrateName=Test API
&MigrateType=2
&SourceType=5
&Source.Url.0=http://gz-oncvm-1254065710.cosgz.myqcloud.com/testdb.bak
&Target.InstanceId=mssql-si2823jyl
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
"MigrateId": 2728
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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.DBError | Database error. |
| InternalError | Internal error. |
| InternalError.CreateFlowFailed | Failed to create flow. |
| InternalError.DBConnectError | Database connection error. |
| InternalError.DBError | Database error |
| InternalError.SystemError | System error. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.InputIllegal | Input error. |
| InvalidParameter.ParamsAssertFailed | An error occurred while converting parameter assertion. |
| InvalidParameterValue.MigrationNameIsIllegal | The migration name contains invalid characters. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceUnavailable.InstanceMigrateRegionIllegal | Invalid instance migration region. |
| ResourceUnavailable.InstanceMigrateStatusInvalid | Invalid instance migration status. |
| ResourceUnavailable.InstanceStatusInvalid | Invalid instance status. |
| UnauthorizedOperation.PermissionDenied | CAM authentication error. |
Yes
No
Was this page helpful?