创建手动备份
功能介绍
创建手动备份。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/backups/create
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围:
默认取值: en-us |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
是 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 |
name |
是 |
String |
参数解释: 备份名称。 取值范围: 取值范围:最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 |
description |
否 |
String |
参数解释: 备份描述。 取值范围: 不能包含特殊字符 ! < " = ' > &和回车,不大于256个字符。 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
backup |
backup object |
参数解释: 备份信息。 |
job_id |
String |
参数解释: 任务ID。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 备份ID。 取值范围: 不涉及。 |
name |
String |
参数解释: 备份名称。 取值范围: 取值范围:最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 |
description |
String |
参数解释: 备份描述。 取值范围: 不能包含特殊字符 ! < " = ' > &和回车,不大于256个字符。 |
begin_time |
String |
参数解释: 备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”,其中T指时间字段的开始;Z指时区偏移量。 取值范围: 不涉及。 |
status |
String |
参数解释: 备份状态。 取值范围:
|
type |
String |
参数解释: 备份类型。 取值范围: manual:手动全量备份。 |
instance_id |
String |
参数解释: 实例ID。 取值范围: 与请求参数保持一致。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
创建手动备份。
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create
{
"instance_id" : "e761be53970c48aeb2073b179dccfab9in07",
"name" : "backup-1",
"description" : "手动备份"
}
响应示例
状态码:201
Success.
{
"backup" : {
"id" : "f58f674c11224fd99772b89f892da6f5br07",
"name" : "backup-1",
"description" : "手动备份",
"begin_time" : "2020-07-07T01:17:05+0800",
"status" : "BUILDING",
"type" : "manual",
"instance_id" : "ef25188419f941309882d2986b2210b9in07"
},
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}
SDK代码示例
SDK代码示例如下。
创建手动备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
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 CreateGaussMySqlBackupSolution {
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("<YOUR REGION>"))
.build();
CreateGaussMySqlBackupRequest request = new CreateGaussMySqlBackupRequest();
MysqlCreateBackupRequest body = new MysqlCreateBackupRequest();
body.withDescription("手动备份");
body.withName("backup-1");
body.withInstanceId("e761be53970c48aeb2073b179dccfab9in07");
request.withBody(body);
try {
CreateGaussMySqlBackupResponse response = client.createGaussMySqlBackup(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());
}
}
}
|
创建手动备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# 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("<YOUR REGION>")) \
.build()
try:
request = CreateGaussMySqlBackupRequest()
request.body = MysqlCreateBackupRequest(
description="手动备份",
name="backup-1",
instance_id="e761be53970c48aeb2073b179dccfab9in07"
)
response = client.create_gauss_my_sql_backup(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
创建手动备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
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 := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := gaussdb.NewGaussDBClient(
gaussdb.GaussDBClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateGaussMySqlBackupRequest{}
descriptionMysqlCreateBackupRequest:= "手动备份"
request.Body = &model.MysqlCreateBackupRequest{
Description: &descriptionMysqlCreateBackupRequest,
Name: "backup-1",
InstanceId: "e761be53970c48aeb2073b179dccfab9in07",
}
response, err := client.CreateGaussMySqlBackup(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
创建手动备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
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 CreateGaussMySqlBackupSolution {
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("<YOUR REGION>"))
.build();
CreateGaussMySqlBackupRequest request = new CreateGaussMySqlBackupRequest();
MysqlCreateBackupRequest body = new MysqlCreateBackupRequest();
body.withDescription("手动备份");
body.withName("backup-1");
body.withInstanceId("e761be53970c48aeb2073b179dccfab9in07");
request.withBody(body);
try {
CreateGaussMySqlBackupResponse response = client.createGaussMySqlBackup(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());
}
}
}
|
创建手动备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# 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("<YOUR REGION>")) \
.build()
try:
request = CreateGaussMySqlBackupRequest()
request.body = MysqlCreateBackupRequest(
description="手动备份",
name="backup-1",
instance_id="e761be53970c48aeb2073b179dccfab9in07"
)
response = client.create_gauss_my_sql_backup(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
创建手动备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
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 := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := gaussdb.NewGaussDBClient(
gaussdb.GaussDBClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateGaussMySqlBackupRequest{}
descriptionMysqlCreateBackupRequest:= "手动备份"
request.Body = &model.MysqlCreateBackupRequest{
Description: &descriptionMysqlCreateBackupRequest,
Name: "backup-1",
InstanceId: "e761be53970c48aeb2073b179dccfab9in07",
}
response, err := client.CreateGaussMySqlBackup(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。