查询指定实例全量备份列表 - ShowInstanceBackups
功能介绍
查询指定实例全量备份列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v3/{project_id}/instances/{instance_id}/backups
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID,此参数是实例的唯一标识。 获取方法请参见查询实例列表。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | String | 参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为整数,不能为负数。 取值范围: ≥0。 默认取值: 0。 |
| limit | 否 | String | 参数解释: 查询记录数。 约束限制: 必须为整数,不能为负数。 取值范围: 1-100。 默认取值: 100。 |
| order_field | 否 | String | 参数解释: 根据指定字段排序。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| order_rule | 否 | String | 参数解释: 排序规则。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| filter_field | 否 | String | 参数解释: 过滤字段类型。 约束限制: 不涉及。 取值范围: name:根据备份名称进行过滤。 默认取值: 不涉及。 |
| filter_content | 否 | String | 参数解释: 过滤内容。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| backups | Array of BackupV3 objects | 参数解释: 指定实例全量备份信息列表。 |
| total_count | String | 参数解释: 总备份数量。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 备份ID。 取值范围: 不涉及。 |
| description | String | 参数解释: 备份描述。 取值范围: 不涉及。 |
| instance_id | String | 参数解释: 实例ID。 取值范围: 不涉及。 |
| instance_name | String | 参数解释: 实例名称。 取值范围: 不涉及。 |
| name | String | 参数解释: 备份名称。 取值范围: 不涉及。 |
| size | String | 参数解释: 备份大小。 取值范围: 不涉及。 |
| size_unit | String | 参数解释: 大小单位(KB)。 取值范围: 不涉及。 |
| status | String | 参数解释: 备份状态。 取值范围: |
| created | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| updated | String | 参数解释: 更新时间。 取值范围: 不涉及。 |
| backup_type | String | 参数解释: 备份类型。 取值范围: |
| backup_level | String | 参数解释: 备份级别。 取值范围: |
| backup_method | String | 参数解释: 备份方法。 取值范围: |
| use_detail | String | 参数解释: 使用详情。 取值范围: 不涉及。 |
| time_zone | String | 参数解释: UTC时区。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
请求示例
查询实例的备份列表。
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups?offset=0&limit=100 响应示例
状态码:200
Success.
{
"backups" : [ {
"id" : "backup-001",
"description" : "每日自动备份",
"instance_id" : "instance-123",
"instance_name" : "prod-db",
"name" : "daily-backup-20231101",
"size" : "74464.0",
"size_unit" : "KB",
"status" : "COMPLETED",
"created" : "2026-01-04 17:30:30",
"updated" : "2026-01-04 17:34:24",
"backup_type" : "Db",
"backup_level" : "2",
"backup_method" : "Db",
"use_detail" : "生产环境备份",
"time_zone" : "UTC+08:00"
} ],
"total_count" : "1"
} 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 | 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 ShowInstanceBackupsSolution { 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(); ShowInstanceBackupsRequest request = new ShowInstanceBackupsRequest(); request.withInstanceId("{instance_id}"); try { ShowInstanceBackupsResponse response = client.showInstanceBackups(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 | # 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 = ShowInstanceBackupsRequest() request.instance_id = "{instance_id}" response = client.show_instance_backups(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 44 45 46 47 48 49 50 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.ShowInstanceBackupsRequest{} request.InstanceId = "{instance_id}" response, err := client.ShowInstanceBackups(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success. |
| 400 | Client error. |
| 500 | Server error. |
错误码
请参见错误码。