DescribeUploadBackupInfo

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeUploadBackupInfo.
Version	Yes	String	Common parameter. The value used for this API: 2018-03-28.
Region	Yes	String	Common parameter. 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)
XCosSecurityToken	String	Temporary key (Token)
StartTime	String	Temporary key start time
ExpiredTime	String	Temporary key expiration time
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the upload key of full backups

Input Example

https://sqlserver.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.

Command Line Interface

Tencent Cloud CLI 3.0

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.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Tencent Cloud Partner Network

Become a Partner

International Partner Academy

Recent Pages