PluginBench
Skill
Pass
Audit score 90

huawei-cloud-obs-stats

huaweicloud/huaweicloud-skills

Query Huawei Cloud OBS bucket statistics, download traffic, and request metrics with month-over-month comparison.

What is huawei-cloud-obs-stats?

This skill queries Huawei Cloud Object Storage Service (OBS) statistics including bucket capacity and object counts, download traffic (extranet/intranet) with month-over-month comparison, and total request counts with month-over-month comparison. Use it when you need to monitor OBS storage usage, traffic patterns, or request volumes.

  • List OBS buckets with storage capacity and object count metrics
  • Query extranet and intranet download traffic with month-over-month comparison
  • Query total request counts with month-over-month comparison
  • Retrieve CES monitoring metrics for OBS bucket performance

How to install huawei-cloud-obs-stats

npx skills add https://github.com/huaweicloud/huaweicloud-skills --skill huawei-cloud-obs-stats
Prerequisites
  • Huawei Cloud CLI (hcloud/KooCLI) version 3.2.0 or higher
  • obsutil version 5.5.0 or higher for OBS bucket operations
  • obsutil credentials configured with AK/SK and endpoint
  • Huawei Cloud IAM permissions for obs:bucket:list, obs:bucket:get, obs:object:get, and ces:metric:get
Claude Code
Cursor
Windsurf
Cline

How to use huawei-cloud-obs-stats

  1. 1.Verify hcloud version is 3.2.0+ by running: hcloud version
  2. 2.Verify obsutil version is 5.5.0+ by running: obsutil version
  3. 3.Configure obsutil credentials by running: hcloud obs config -i=<YourAK> -k=<YourSK> -e=obs.<Region>.myhuaweicloud.com
  4. 4.Request bucket statistics using the skill (e.g., 'list my OBS buckets with capacity')
  5. 5.Query traffic metrics by specifying time period (e.g., 'show download traffic with month-over-month comparison')
  6. 6.Query request counts to analyze usage patterns

Use cases

Good for
  • Monitor storage capacity and object counts across multiple OBS buckets
  • Track download traffic trends and compare current month against previous month
  • Analyze request patterns and identify traffic spikes or anomalies
  • Generate reports on OBS usage and performance metrics
Who it's for
  • Cloud operations engineers managing Huawei Cloud OBS
  • DevOps teams monitoring storage and traffic metrics
  • System administrators tracking cloud resource usage
  • Data analysts reviewing OBS performance trends

huawei-cloud-obs-stats FAQ

What credentials do I need to use this skill?

You need Huawei Cloud Access Key ID (AK) and Access Key Secret (SK) configured via obsutil. Run 'hcloud obs config -i=<AK> -k=<SK> -e=obs.<Region>.myhuaweicloud.com' to configure. Do not provide credentials directly in conversation.

Can this skill delete buckets or objects?

No. This skill is restricted to read-only operations. Delete operations (DeleteBucket, DeleteObject, batch delete) are prohibited for security reasons. Use the Huawei Cloud console or obsutil manually for deletions.

What is month-over-month (MoM) comparison?

MoM comparison shows how current month metrics compare to the previous month, helping identify trends in traffic and request patterns.

Which metrics does this skill query?

The skill queries CES (Cloud Eye Service) metrics including capacity_total (storage capacity), object_num_all (object count), download traffic (extranet/intranet), and total request counts.

What should I do if I get a credential configuration error?

Run 'hcloud obs ls -limit=1' to check if credentials are configured. If you see 'Please set ak, sk and endpoint', configure credentials using 'hcloud obs config' with your AK, SK, and the appropriate endpoint for your region.

Full instructions (SKILL.md)

Source of truth, from huaweicloud/huaweicloud-skills.


name: huawei-cloud-obs-stats description: | Query Huawei Cloud OBS (Object Storage Service) statistics: list buckets with capacity and object counts, query extranet/intranet download traffic with month-over-month comparison, and query total requests with month-over-month comparison. Use this skill when the user wants to: (1) list OBS buckets and check their storage capacity and object count, (2) query download traffic with MoM comparison, (3) query request counts with MoM comparison. Trigger: user mentions "OBS", "object storage", "bucket list", "bucket capacity", "download traffic", "total requests", "request count", "month-over-month", "OBS stats", "OBS management", "对象存储", "桶列表", "桶容量", "下载流量", "请求总数", "月环比", "OBS监控" tags: ["huawei-cloud", "obs", "stats", "obs metrics"]

Huawei Cloud OBS Statistics Skill

Overview

Query Huawei Cloud OBS (Object Storage Service) statistics: list buckets with capacity and object counts, query extranet/intranet download traffic with month-over-month comparison, and query total requests with month-over-month comparison.

⛔ Prohibited Operations (Security Constraints)

This skill strictly forbids the following delete operations, regardless of user requests:

Prohibited OperationAPI/CommandReason
❌ Delete bucketDeleteBucket / obsutil rm -bucketIrreversible; destroys the entire bucket and all objects
❌ Delete objectDeleteObject / obsutil rmIrreversible; deleted objects cannot be recovered (unless versioning is enabled)
❌ Batch delete objectsDeleteObjects / obsutil rm -rIrreversible; batch deletion has a wide impact
❌ Empty bucketobsutil rm -bucket -rIrreversible; removes all objects in the bucket

If a user requests a delete operation, you must refuse and inform: "Per security constraints, this skill does not allow delete operations (delete bucket/object/batch delete/empty bucket). Please use the Huawei Cloud OBS console or obsutil manually."

Architecture

Huawei Cloud OBS Statistics
├── ListBucketsWithStats  (List buckets with capacity and object counts)
├── GetTraffic           (Query extranet/intranet download traffic with MoM comparison)
└── GetRequests           (Query total requests with MoM comparison)

Prerequisites

Prerequisite check 1/3: Huawei Cloud CLI (hcloud / KooCLI) >= 3.2.0 required Run hcloud version to verify version >= 3.2.0. If not installed or version is too low, see references/cli-installation-guide.md for installation guide.

hcloud version

Prerequisite check 2/3: obsutil >= 5.5.0 required (for OBS bucket listing) The hcloud OBS module uses obsutil under the hood. Bucket listing requires the obsutil CLI tool. Run obsutil version to verify version >= 5.5.0. If not installed, see references/cli-installation-guide.md for installation guide.

obsutil version

Prerequisite check 3/3: obsutil credential configuration required

The hcloud OBS module uses obsutil under the hood, which requires separate AK/SK and Endpoint configuration. Before performing OBS operations, you must check whether obsutil credentials are configured:

hcloud obs ls -limit=1

If the response is Please set ak, sk and endpoint in the configuration file! or InvalidAccessKeyId, obsutil credentials are not configured.

Resolution: Provide the following example command and have the user configure it in their terminal (do not ask the user to provide AK/SK directly in the conversation):

obsutil credentials are not configured. Please run the following command in your terminal to configure (AK/SK can be obtained from the Huawei Cloud console "My Credentials" page):

  hcloud obs config -i=<YourAK> -k=<YourSK> -e=obs.<Region>.myhuaweicloud.com

Example (Guangzhou region):
  hcloud obs config -i=<YourAK> -k=<YourSK> -e=obs.cn-south-1.myhuaweicloud.com

Common Endpoints:
  cn-north-4  → obs.cn-north-4.myhuaweicloud.com
  cn-east-3   → obs.cn-east-3.myhuaweicloud.com
  cn-south-1  → obs.cn-south-1.myhuaweicloud.com
  cn-southwest-2 → obs.cn-southwest-2.myhuaweicloud.com

Retry after configuration is complete.

Prohibited actions:

  • ❌ Do not ask the user to provide AK/SK directly in the conversation
  • ❌ Do not extract AK/SK from hcloud config files (credentials are encrypted and cannot be used directly)
  • ❌ Do not skip the credential check before performing OBS operations

⚠️ hcloud parameter format requirements

hcloud (KooCLI) all parameters must use the --param=value format (connected with equals sign); space-separated format is not supported.

✅ Correct: hcloud OBS ListBuckets --region=cn-south-1

❌ Incorrect: hcloud OBS ListBuckets --region cn-south-1

[Conditional] CLI User-Agent — hcloud OBS module commands may include a User-Agent header, but the CES module does not support this parameter:

  • ✅ OBS module: hcloud obs ls
  • ❌ CES module: hcloud CES ShowMetricData does not support --User-Agent; appending it causes "Invalid parameter: User-Agent"

Authentication

Prerequisite check: Huawei Cloud credentials required

Security rules (must be followed):

  • Prohibited from reading, echoing, or printing AK/SK values
  • Prohibited from asking the user to input AK/SK directly in the conversation
  • Prohibited from using hcloud configure set to pass plaintext credential values
  • Prohibited from accepting AK/SK directly provided by the user in the conversation
  • Only allowed to read credentials from environment variables or configured CLI config files

⚠️ Important: Handling user-provided credentials

If a user attempts to provide AK/SK directly (e.g., "my AK is xxx, SK is yyy"):

  1. Stop immediately - Do not execute any commands
  2. Politely refuse and return the following message:
    For account security, please do not provide Huawei Cloud Access Key ID and Access Key Secret directly in the conversation.
    
    Please use one of the following secure methods to configure credentials:
    
    Method 1: Interactive configuration (recommended)
        hcloud configure
        # Enter AK/SK as prompted; credentials will be securely stored in a local config file
    
    Method 2: Environment variable configuration
        export HUAWEICLOUD_SDK_AK=<your-access-key-id>
        export HUAWEICLOUD_SDK_SK=<your-access-key-secret>
    
    After configuration is complete, please retry your request.
    
  3. Do not continue executing any Huawei Cloud operations until credentials are configured

Check CLI configuration:

   hcloud configure list

Check whether the output contains valid configuration (AK/SK, IAM, etc.).

If no valid credentials exist, stop here.


IAM Permission Policies

Ensure the IAM user has the required permissions. See references/iam-policies.md for details.

Minimum required permissions:

  • obs:bucket:list — List buckets
  • obs:bucket:get — Get bucket attributes
  • obs:object:get — Read object information
  • ces:metric:get — Query CES monitoring metrics (capacity, object count, traffic, request count)

Core Workflows

Task 1: List Buckets with Capacity and Object Counts

List buckets via obsutil, then query bucket capacity and object count via CES. Prefer the CES capacity_total metric for capacity and CES object_num_all metric for object count (efficient for batch queries, 30-min collection). Do not use GetBucketStorageInfo (not supported by hcloud OBS module).

📄 Detailed steps → references/task-list-buckets-with-stats.md

Task 2: Query Extranet/Intranet Download Traffic (with MoM Comparison)

Query download traffic (extranet + intranet) via CES ShowMetricData, with month-over-month comparison.

📄 Detailed steps → references/task-query-traffic.md

Task 3: Query Total Requests (with MoM Comparison)

Query total requests (sum of GET/PUT/POST/DELETE/HEAD) via CES ShowMetricData, with month-over-month comparison.

📄 Detailed steps → references/task-query-requests.md


Core Commands

CommandDescription
hcloud obs lsList all buckets (obsutil mode); filter by region via grep
hcloud CES ShowMetricData --region=<R> --namespace=SYS.OBS --metric_name=<M> --dim.0=bucket_name,<B> --period=86400 --filter=<F> --from=<ms> --to=<ms>Query CES metric data (capacity, object count, traffic, requests)
python3 scripts/obs_traffic_stats.py --region <R> --bucket <B> (--period <P> | --from <D> --to <D>) [--direction download|upload|both]Traffic statistics with MoM
python3 scripts/obs_request_stats.py --region <R> --bucket <B> (--period <P> | --from <D> --to <D>) [--include-errors]Request statistics with MoM

⚠️ CES ShowMetricData does not support --User-Agent; appending it causes errors.

Common CES metrics:

Metric--metric_name--filter
Bucket capacity (recommended)capacity_totalaverage
Bucket object count (recommended)object_num_allaverage
Extranet download trafficdownload_traffic_extranetsum
Intranet download trafficdownload_traffic_intranetsum
GET / PUT / POST / DELETE / HEAD requestsget_request_count / put_request_count / post_request_count / delete_request_count / head_request_countsum

Parameter Confirmation

Before executing any task, the following parameters must be confirmed with the user. Guessing is prohibited.

ParameterRequired/OptionalDescriptionDefault
--regionRequiredHuawei Cloud region (e.g., cn-south-1, cn-north-4); must be explicitly provided by the user-
Bucket nameRequiredOBS bucket name; dimension format: --dim.0=bucket_name,<BucketName>-
Time rangeRequiredMust precisely match user's wording: "this month" ≠ "last 30 days" (see table below)-
obsutil credentialsRequiredCheck via hcloud obs ls -limit=1 before any OBS operation-
--directionOptionalTraffic direction: download / upload / bothdownload
--include-errorsOptionalAlso query 4xx/5xx error request countsfalse
--compareOptionalShow comparison period and MoM change. Default disabled; enable only when the user explicitly asks for comparison/MoMfalse
--metricOptionalComma-separated metric keys to show only specific rows. obs_request_stats.py: total,get,put,post,delete,head,4xx,5xx; obs_traffic_stats.py: extranet,intranet,total. Case-insensitive. Specifying 4xx/5xx auto-enables error query. Example: --metric 4xx,5xx, --metric intranet-

Time range disambiguation:

User's wordingTime range
"this month"1st of current month 00:00:00 ~ now
"last 30 days" / "past month"now - 30 days ~ now
"last month"1st of last month 00:00:00 ~ last day of last month 23:59:59
Specific date rangeUser-specified start and end times

Script Tools

This skill provides the following Python scripts that encapsulate best practices for traffic and request statistics:

ScriptDescription
obs_traffic_stats.pyDownload/upload traffic statistics with MoM comparison. Options: --direction, --compare, --metric. Comparison disabled by default. See Core Commands above for usage.
obs_request_stats.pyTotal request statistics (GET/PUT/POST/DELETE/HEAD) with MoM comparison. Options: --include-errors, --compare, --metric. Comparison disabled by default. See Core Commands above for usage.

Usage examples:

# Traffic: last 30 days download traffic
python3 scripts/obs_traffic_stats.py --region <Region> --bucket <BucketName> --period last_30d

# Traffic: this month download + upload traffic
python3 scripts/obs_traffic_stats.py --region <Region> --bucket <BucketName> --period this_month --direction both

# Requests: last 30 days request count
python3 scripts/obs_request_stats.py --region <Region> --bucket <BucketName> --period last_30d

# Requests: this month request count (with 4xx/5xx error stats)
python3 scripts/obs_request_stats.py --region <Region> --bucket <BucketName> --period this_month --include-errors

# Custom date range
python3 scripts/obs_request_stats.py --region <Region> --bucket <BucketName> --from <FromDate> --to <ToDate>

The scripts incorporate key lessons learned: traffic vs. bandwidth metrics, hcloud dimension parameter format, precise time range matching, OBS lacking a single request_count metric, etc.


Verification Method

See references/verification-method.md for details.

Quick validation:

# Check OBS bucket list (using obsutil)
hcloud obs ls -limit=1

# Check obsutil configuration
obsutil ls -limit=1

# Validate traffic stats script
python3 scripts/obs_traffic_stats.py --region <Region> --bucket <BucketName> --period last_30d

# Validate request stats script
python3 scripts/obs_request_stats.py --region <Region> --bucket <BucketName> --period last_30d

References

DocumentDescription
task-list-buckets-with-stats.mdTask 1: List buckets with capacity and object counts
task-query-traffic.mdTask 2: Query download traffic with MoM
task-query-requests.mdTask 3: Query total requests with MoM
related-apis.mdAPI and CLI command details
iam-policies.mdIAM permission policies
obs-metrics.mdOBS CES monitoring metrics reference
verification-method.mdVerification steps
acceptance-criteria.mdCorrect/error pattern comparison
cli-installation-guide.mdCLI installation guide
troubleshooting.mdTroubleshooting and practical experience
obs_traffic_stats.pyTraffic statistics script
obs_request_stats.pyRequest statistics script