Creating a Backup Resource Package

Function

This API is used to purchase a yearly/monthly backup resource package. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependency

gaussdbformysql:backup:createResourcePackage

Write

-

-

gaussdb:backup:createResourcePackage

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
gaussdbformysql:backup:createResourcePackage	Write	-	-	gaussdb:backup:createResourcePackage	-

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
spec_code	Yes	String	Definition Backup resource package specification code. Constraints N/A Range The specification code can be obtained by calling the API for querying backup resource package specifications. Default Value N/A
num	Yes	Integer	Definition Number of backup resource packages. Constraints N/A Range 1–10 Default Value N/A
charge_info	Yes	TaurusDbChargeInfo object	Definition Billing information. Constraints N/A

**Table 4** TaurusDbChargeInfo
Parameter	Mandatory	Type	Description
period_type	Yes	String	Definition Subscription type. Constraints N/A Range month: monthly year: yearly Default Value N/A
period_num	Yes	Integer	Definition Subscription period. Constraints The value must correspond to the subscription period allowed by period_type. Range When period_type is set to month, the value range is 1 to 9. When period_type is set to year, the value range is 1 to 3. Default Value N/A
is_auto_renew	No	Boolean	Definition Whether automatic renewal is enabled. The renewal period is the same as the original period, and the order will be automatically paid. Constraints N/A Range true: Automatic renewal is enabled. false: Automatic renewal is disabled. Default Value false
is_auto_pay	No	Boolean	Definition Whether the order will be automatically paid. This parameter does not affect the payment method of automatic renewal. Constraints N/A Range true: The order will be automatically paid. false: The order will be manually paid. Default Value false

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
order_id	String	Definition ID of the order for creating the backup resource package. Range N/A
spec_code	String	Definition Backup resource package specification code. Range N/A
num	Integer	Definition Number of backup resource packages. Range 1–10
period_type	String	Definition Subscription type. Range month: monthly year: yearly
period_num	Integer	Definition Subscription period. Range When period_type is set to month, the value range is 1 to 9. When period_type is set to year, the value range is 1 to 3.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Purchasing a backup resource package

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

Example Response

Status code: 200

Success.

Purchasing a backup resource package

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

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Backup Management

Previous topic: Querying Backup Resource Package Specifications

Next topic: Deleting Manual Backups in Batches

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot