DescribeBackupSet - PolarDB - Alibaba Cloud Documentation Center

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 for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeBackupSet	The operation that you want to perform. Set the value to DescribeBackupSet.
DBInstanceName	String	Yes	pxc-htri0ori2r****	The name of the instance.
BackupSetId	String	Yes	111	The ID of the backup set.
RegionId	String	No	cn-hangzhou	The region ID of the instance.
DestCrossRegion	String	No	cn-shanghai	The region in which you want to store cross-region backups.

Response parameters

Parameter	Type	Example	Description
Message	String	successs	The error message.
RequestId	String	1A6D328C-84B8-40DC-BF49-6C73984D7494	The request ID.
Success	Boolean	true	Indicates whether the request was successful.
Data	Array of BackupSet		The returned data.
EndTime	Long	1650251308000	The end time of the backup.
Status	Integer	1	The status of the backup set. Valid values: 0: The system is backing up the data. 1: The backup is successful. 2: The backup failed.
BackupSetSize	Long	88803195	The size of the backup set. Unit: bytes.
BackupSetId	Long	111	The ID of the backup set.
BackupType	Integer	1	The type of the backup. Valid values: 0: fast backup 1: consistent backup
BeginTime	Long	1650250861754	The start time of the backup.
BackupModel	Integer	0	The backup method. Valid values: 0: automatic backup 1: manual backup
OSSList	Array of OSS		The information about backup files that are stored in Object Storage Service (OSS).
BackupSetFile	String	hins3084_data_20220418110623_qp.xb	The name of the backup file in OSS.
LinkExpiredTime	String	2022-04-20T08:01:37Z	The point in time when the URL of the backup file expires.
IntranetDownloadLink	String	http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?	The internal download URL of the backup file.
DownloadLink	String	https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI5tJEmRFdJ8aBPDR7****&Expires=1650441697&dd=7KJzkUSbXf6dwy	The external download URL of the backup file.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeBackupSet
&DBInstanceName=pxc-htri0ori2r****
&BackupSetId=111
&RegionId=cn-hangzhou
&DestCrossRegion=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupSetResponse>
    <Message>successs</Message>
    <RequestId>1A6D328C-84B8-40DC-BF49-6C73984D7494</RequestId>
    <Success>true</Success>
    <Data>
        <EndTime>1650251308000</EndTime>
        <Status>1</Status>
        <BackupSetSize>88803195</BackupSetSize>
        <BackupSetId>111</BackupSetId>
        <BackupType>1</BackupType>
        <BeginTime>1650250861754</BeginTime>
        <BackupModel>0</BackupModel>
        <OSSList>
            <BackupSetFile>hins3084_data_20220418110623_qp.xb</BackupSetFile>
            <LinkExpiredTime>2022-04-20T08:01:37Z</LinkExpiredTime>
            <IntranetDownloadLink>http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?</IntranetDownloadLink>
            <DownloadLink>https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI5tJEmRFdJ8aBPDR7****&amp;Expires=1650441697&amp;dd=7KJzkUSbXf6dwy</DownloadLink>
        </OSSList>
    </Data>
</DescribeBackupSetResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "successs",
  "RequestId" : "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "Success" : true,
  "Data" : [ {
    "EndTime" : 1650251308000,
    "Status" : 1,
    "BackupSetSize" : 88803195,
    "BackupSetId" : 111,
    "BackupType" : 1,
    "BeginTime" : 1650250861754,
    "BackupModel" : 0,
    "OSSList" : [ {
      "BackupSetFile" : "hins3084_data_20220418110623_qp.xb",
      "LinkExpiredTime" : "2022-04-20T08:01:37Z",
      "IntranetDownloadLink" : "http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?",
      "DownloadLink" : "https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI5tJEmRFdJ8aBPDR7****&Expires=1650441697&dd=7KJzkUSbXf6dwy"
    } ]
  } ]
}

Error codes

For a list of error codes, see Service error codes.