文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 备份管理/ 创建备份资源包 - CreateBackupResourcePackage
更新时间：2026-05-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建备份资源包 - CreateBackupResourcePackage

功能介绍

购买新的包年/包月备份资源包。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:backup:createResourcePackage

    Write

    -

    -

    gaussdb:backup:createResourcePackage

    -

URI

POST /v3/{project_id}/backups/resource-package

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us：英文。

  • zh-cn：中文。

默认取值：

en-us。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

application/json。
表3 请求Body参数

参数

是否必选

参数类型

描述

spec_code

是

String

参数解释：

备份资源包规格码。

约束限制：

不涉及。

取值范围：

备份资源包规格码可根据查询备份资源包规格接口获取。

默认取值：

不涉及。

num

是

Integer

参数解释：

备份资源包数量。

约束限制：

不涉及。

取值范围：

1-10。

默认取值：

不涉及。

charge_info

是

TaurusDbChargeInfo object

参数解释：

计费类型信息。

约束限制：

不涉及。
表4 TaurusDbChargeInfo

参数

是否必选

参数类型

描述

period_type

是

String

参数解释：

订购周期类型。

约束限制：

不涉及。

取值范围：

  • month：包月。

  • year：包年。

默认取值：

不涉及。

period_num

是

Integer

参数解释：

订购时间长度。

约束限制：

需要和period_type允许的订购时间长度对应。

取值范围：

  • “period_type”为“month”时，取值为1~9。

  • “period_type”为“year”时，取值为1~3。

默认取值：

不涉及。

is_auto_renew

否

Boolean

参数解释：

是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

约束限制：

不涉及。

取值范围：

  • true：自动续订。

  • false：不自动续订。

默认取值：

false。

is_auto_pay

否

Boolean

参数解释：

是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。

约束限制：

不涉及。

取值范围：

  • true：自动支付。

  • false：手动支付。

默认取值：

false。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

order_id

String

参数解释：

创建备份资源包订单ID。

取值范围：

不涉及。

spec_code

String

参数解释：

备份资源包规格码。

取值范围：

不涉及。

num

Integer

参数解释：

备份资源包数量。

取值范围：

1-10。

period_type

String

参数解释：

订购周期类型。

取值范围：

  • month：包月。

  • year：包年。

period_num

Integer

参数解释：

订购时间长度。

取值范围：

  • “period_type”为“month”时，取值为1~9。

  • “period_type”为“year”时，取值为1~3。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

购买备份资源包。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/resource-package

{
  "spec_code" : "gaussdb.mysql.backup.pkg.1tb",
  "num" : 1,
  "charge_info" : {
    "period_type" : "year",
    "period_num" : 1,
    "is_auto_pay" : false,
    "is_auto_renew" : false
  }
}

响应示例

状态码：200

Success.

购买备份资源包。

{
  "order_id" : "CS26032015513W796",
  "spce_code" : "gaussdb.mysql.backup.pkg.1tb",
  "num" : 1,
  "period_type" : "year",
  "period_num" : 1
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 备份管理

相关文档