文档

DescribeBackupSet

更新时间:

调用DescribeBackupSet接口查看备份集详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeBackupSet

系统规定参数。取值:DescribeBackupSet

DBInstanceName String pxc-htri0ori2r****

PolarDB-X实例名称。

BackupSetId String 111

备份集ID。

RegionId String cn-hangzhou

地域ID。

DestCrossRegion String cn-shanghai

跨地域备份的目标地域。

返回数据

名称

类型

示例值

描述

Message String successs

错误信息。

RequestId String 1A6D328C-84B8-40DC-BF49-6C73984D7494

请求ID。

Success Boolean true

请求是否成功。

Data Array of BackupSet

数据列表。

EndTime Long 1650251308000

备份结束时间。

Status Integer 1

备份集状态:

  • 0: 备份中;
  • 1:备份成功;
  • 2:备份失败。
BackupSetSize Long 88803195

备份集大小, 单位为byte。

BackupSetId Long 111

备份集ID。

BackupType Integer 1

备份类型:

  • 0:快速备份;
  • 1:一致性备份。
BeginTime Long 1650250861754

备份开始时间。

BackupModel Integer 0

备份模式:

  • 0:自动备份;
  • 1:手动备份。
OSSList Array of OSS

备份集OSS信息列表。

BackupSetFile String hins3084_data_20220418110623_qp.xb

OSS文件名。

LinkExpiredTime String 2022-04-20T08:01:37Z

OSS文件链接过期时间。

IntranetDownloadLink String http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?

内网OSS下载地址。

DownloadLink String https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI5tJEmRFdJ8aBPDR7****&Expires=1650441697&dd=7KJzkUSbXf6dwy

外网下载地址。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupSet
&DBInstanceName=pxc-htri0ori2r****
&BackupSetId=111
&RegionId=cn-hangzhou
&DestCrossRegion=cn-shanghai
&公共请求参数

正常返回示例

XML格式

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格式

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"
    } ]
  } ]
}

错误码

访问错误中心查看更多错误码。