huawei-cloud-vbs-list

Huawei Cloud VBS Backup List Skill

Overview

Query the current user's backup (VBS / Volume Backup Service) list on Huawei Cloud.

Note on VBS → CBR migration: The VBS (Volume Backup Service) has been integrated into CBR (Cloud Backup and Recovery). All backups created under VBS are now managed and queryable through CBR. This skill therefore uses the CBR ListBackups operation (GET /v3/{project_id}/backups) to list backups, which is the successor of the legacy VBS list-backups API.

This skill provides:

• List all backups in the current project
• Filter by status, name, resource type, vault ID, AZ, resource ID, time range, etc.
• Summarize key fields (ID, name, status, resource type, created time, vault)
• CLI-first execution with SDK fallback

Architecture

Huawei Cloud VBS/CBR Backup List
└── ListBackups  (GET /v3/{project_id}/backups)
    ├── CLI:  hcloud CBR ListBackups --cli-region= [--param=value...]
    └── SDK:  huaweicloudsdkcbr.v1.CbrClient.list_backups(ListBackupsRequest)

Prerequisites

Prerequisite check: Huawei Cloud CLI (hcloud / KooCLI) >= 3.2.0 required Check the CLI version (run hcloud with the version argument) and confirm a version string is printed. If not installed or too old, see references/cli-installation-guide.md.

Prerequisite check: Huawei Cloud credentials required Check the CLI profile (run hcloud with the configure list arguments) and confirm a profile with valid AK/SK exists. Credentials must be read from the configured CLI profile or environment variables. Never ask for or echo AK/SK values in the conversation.

IAM Permission Policies

The IAM user must be granted the CBR read permission. See references/iam-policies.md.

Minimum required permissions:

• cbr:backups:list — List backups

Core Workflows

Task 1: List All Backups

Query the full backup list of the current project/region.

hcloud CBR ListBackups --cli-region={region} --limit=50

Task 2: Filter Backups

Apply one or more query filters to narrow down the result.

# By status
hcloud CBR ListBackups --cli-region={region} --status=available

# By name (fuzzy match)
hcloud CBR ListBackups --cli-region={region} --name=backup_for_image

# By resource type
hcloud CBR ListBackups --cli-region={region} --resource_type=OS::Nova::Server

# By vault
hcloud CBR ListBackups --cli-region={region} --vault_id={vault_id}

# By time range (format %YYYY-%mm-%ddT%HH:%MM:%SSZ)
hcloud CBR ListBackups --cli-region={region} --start_time=2026-01-01T00:00:00Z --end_time=2026-12-31T23:59:59Z

Task 3: Paginated / Summarized Output

Pagination and summary of key backup attributes.

# Pagination
hcloud CBR ListBackups --cli-region={region} --limit=10 --offset=10

# Full JSON output (for agent consumption / parsing)
hcloud CBR ListBackups --cli-region={region} --limit=50 --cli-output=json

Core Commands

KooCLI parameter format: all parameters use the --param=value (equals-sign) format.

Status values: available, protecting, deleting, restoring, error, waiting_protect, waiting_delete, waiting_restore.

Resource types: OS::Cinder::Volume (云硬盘), OS::Nova::Server (云服务器).

Script Tools

scripts/list_vbs_backups.py — SDK-based backup listing with summary

Reads AK/SK from HUAWEICLOUD_SDK_AK / HUAWEICLOUD_SDK_SK environment variables (or HUAWEI_ACCESS_KEY / HUAWEI_SECRET_KEY), lists backups via the CBR SDK, and prints a concise summary table.

# List all backups (first page)
python3 scripts/list_vbs_backups.py --region cn-north-4

# Filter by status
python3 scripts/list_vbs_backups.py --region cn-north-4 --status available

# Filter by name / resource type / vault
python3 scripts/list_vbs_backups.py --region cn-north-4 --name backup_for_image --resource-type OS::Nova::Server --vault-id bf33d48b-...

# Control page size
python3 scripts/list_vbs_backups.py --region cn-north-4 --limit 20 --offset 0

Parameter Confirmation

Before executing any task, confirm the following parameters with the user. Guessing is prohibited.

Two parameter conventions — do not mix:

• CLI (hcloud): KooCLI parameters use underscores and the --param=value form, e.g. --resource_type=OS::Nova::Server, --vault_id=, --start_time=....
• SDK script (scripts/list_vbs_backups.py): the script's argparse interface uses hyphens, e.g. --resource-type OS::Nova::Server, --vault-id , --start-time .... Using the underscore form against the script raises unrecognized arguments.

KooCLI Command Format Standard

hcloud   --cli-region= [--key=value ...]

All concrete commands must use the --param=value equals-sign format.

Verification Method

See references/verification-method.md for details.

Quick validation:

# Confirm CLI works (returns backup list or empty array)
hcloud CBR ListBackups --cli-region=cn-north-4 --limit=1

# Confirm SDK script works
python3 scripts/list_vbs_backups.py --region cn-north-4 --limit=5

Reference Documents