# 创建备份资源包 - CreateBackupResourcePackage #### 功能介绍 购买新的包年/包月备份资源包。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:backup:createResourcePackage | Write | - | - | gaussdb:backup:createResourcePackage | - | #### URI POST /v3/{project_id}/backups/resource-package 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"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 | **参数解释**： 备份资源包规格码。 **约束限制**： 不涉及。 **取值范围**： 备份资源包规格码可根据[查询备份资源包规格](https://support.huaweicloud.com/api-taurusdb/ShowBackupResourcePackageFlavors.html)接口获取。 **默认取值**： 不涉及。 | | num | 是 | Integer | **参数解释**： 备份资源包数量。 **约束限制**： 不涉及。 **取值范围**： 1-10。 **默认取值**： 不涉及。 | | charge_info | 是 | [TaurusDbChargeInfo] object | **参数解释**： 计费类型信息。 **约束限制**： 不涉及。 | 表4TaurusDbChargeInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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** 购买备份资源包。 ``` { "order_id" : "CS26032015513W796", "spec_code" : "gaussdb.mysql.backup.pkg.1tb", "num" : 1, "period_type" : "year", "period_num" : 1 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 购买备份资源包。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class CreateBackupResourcePackageSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("")) .build(); CreateBackupResourcePackageRequest request = new CreateBackupResourcePackageRequest(); CreateBackupResourcePackageRequestBody body = new CreateBackupResourcePackageRequestBody(); TaurusDbChargeInfo chargeInfobody = new TaurusDbChargeInfo(); chargeInfobody.withPeriodType(TaurusDbChargeInfo.PeriodTypeEnum.fromValue("year")) .withPeriodNum(1) .withIsAutoRenew(false) .withIsAutoPay(false); body.withChargeInfo(chargeInfobody); body.withNum(1); body.withSpecCode("gaussdb.mysql.backup.pkg.1tb"); request.withBody(body); try { CreateBackupResourcePackageResponse response = client.createBackupResourcePackage(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 购买备份资源包。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("")) \ .build() try: request = CreateBackupResourcePackageRequest() chargeInfobody = TaurusDbChargeInfo( period_type="year", period_num=1, is_auto_renew=False, is_auto_pay=False ) request.body = CreateBackupResourcePackageRequestBody( charge_info=chargeInfobody, num=1, spec_code="gaussdb.mysql.backup.pkg.1tb" ) response = client.create_backup_resource_package(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 购买备份资源包。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.CreateBackupResourcePackageRequest{} isAutoRenewChargeInfo:= false isAutoPayChargeInfo:= false chargeInfobody := &model.TaurusDbChargeInfo{ PeriodType: model.GetTaurusDbChargeInfoPeriodTypeEnum().YEAR, PeriodNum: int32(1), IsAutoRenew: &isAutoRenewChargeInfo, IsAutoPay: &isAutoPayChargeInfo, } request.Body = &model.CreateBackupResourcePackageRequestBody{ ChargeInfo: chargeInfobody, Num: int32(1), SpecCode: "gaussdb.mysql.backup.pkg.1tb", } response, err := client.CreateBackupResourcePackage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=CreateBackupResourcePackage)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。