- 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 query a backup upload permission.
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: DescribeUploadBackupInfo. |
| 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. |
| InstanceId | Yes | String | ID of imported target instance |
| BackupMigrationId | Yes | String | Backup import task ID, which is returned through the API CreateBackupMigration |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| BucketName | String | Bucket name |
| Region | String | Bucket location information |
| Path | String | Storage path |
| TmpSecretId | String | Temporary key ID |
| TmpSecretKey | String | Temporary key (Key) |
| StartTime | String | Temporary key start time |
| ExpiredTime | String | Temporary key expiration time |
| CosSecurityToken | String | |
| 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 Querying the upload key of full backups
Input Example
https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeUploadBackupInfo
&InstanceId=mssql-rdc0gajn
&BackupMigrationId=mssql-backup-migration-kpl74n9l
&<common request parameters>
Output Example
{
"Response": {
"BucketName": "cosbacktest-1254065710",
"ExpiredTime": "1601205149",
"Path": "251006279/sqlserver/mssql-rdc0gajn/migration/backup/mssql-backup-migration-kpl74n9l/",
"Region": "ap-guangzhou",
"RequestId": "6ce2010c-a9c2-474d-860e-f2c8581304eb",
"StartTime": "1601204649",
"TmpSecretId": "AKID44fDXXXXXXXXXXXXXXXXXXXXXXXXX",
"TmpSecretKey": "2jWOoltcvf21JIsNUaXXXXXXXXXXXXXXXXXXXXXXXXX",
"XCosSecurityToken": "J6nJk8Q30PaQwyvn4OF4oOezabX61kra1cf794342ff14c39705aa17584f81650YmAxWf4vkrV2ZK2Gcr_-kzjJ7a_fRRCeQtXd547VoWnmbJ2txpX6Kj_SywpVdS4c4sMrIn2aFir1nmTu--k_a9NDyykODaR2O3n-PP_k84qacwjb-XXXXXXXXXXXXXXXXXXXXXXXXX"
}
}
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.CosPropertiesError | Errors occurred while acquiring uploaded configuration information. |
| FailedOperation.MigrationLockError | Locking the backup import task failed. |
| InternalError.DBError | Database error |
| InternalError.StsError | Errors occurred while acquiring temporary keys. |
| InvalidParameter.InputIllegal | Input error. |
| InvalidParameter.ParamsAssertFailed | An error occurred while converting parameter assertion. |
| InvalidParameterValue.CosPathError | Wrong upload path. |
| ResourceNotFound.FullBackupMigrationNotExist | The full backup import task does not exist. |
| ResourceUnavailable.CosStatusErr | A wrong status of offline restoration tasks. |
| UnauthorizedOperation.PermissionDenied | CAM authentication error. |
| UnsupportedOperation.UploadTypeError | A wrong upload type. |
Yes
No
Was this page helpful?