Memory

huawei-cloud-modelarts-notebook-management

Try it

Manage Huawei Cloud ModelArts Notebook instances through full lifecycle operations via hcloud CLI. Covers 31 API interfaces across 7 functional domains: instance management (create/list/show/update/delete/start/stop), lease management (show/renew), tag management (show/create/delete), image management (create/list/register/show/delete/sync/group operations), flavor and cluster queries (list flavors/switchable flavors/clusters/features), and dynamic storage management (list/attach/show/detach). All write operations require user confirmation before execution. Triggers include: "ModelArts notebook", "notebook实例", "创建notebook", "查询notebook", "启动notebook", "停止notebook", "删除notebook", "notebook镜像", "notebook规格", "notebook存储", "notebook标签", "notebook租期", "manage notebook", "notebook management", "ModelArts notebook management".

What it does

Manage Huawei Cloud ModelArts Notebook instances through full lifecycle operations via hcloud CLI. Covers 31 API interfaces across 7 functional domains: instance management (create/list/show/update/delete/start/stop), lease management (show/renew), tag management (show/create/delete), image management (create/list/register/show/delete/sync/group operations), flavor and cluster queries (list flavors/switchable flavors/clusters/features), and dynamic storage management (list/attach/show/detach). All write operations require user confirmation before execution. Triggers include: "ModelArts notebook", "notebook实例", "创建notebook", "查询notebook", "启动notebook", "停止notebook", "删除notebook", "notebook镜像", "notebook规格", "notebook存储", "notebook标签", "notebook租期", "manage notebook", "notebook management", "ModelArts notebook management".

The skill document

Huawei Cloud ModelArts Notebook Management

Full lifecycle management for ModelArts Notebook instances via hcloud CLI — 31 API interfaces across 7 functional domains.


Overview

This skill enables users to manage Huawei Cloud ModelArts Notebook instances through the hcloud CLI. It covers the complete notebook lifecycle including instance CRUD, start/stop, lease renewal, tag management, image management, flavor/cluster queries, feature queries, and dynamic storage management.

Architecture

User Request → Agent → hcloud ModelArts  --cli-region={region} [--params] → Huawei Cloud ModelArts API

Applicable Scenarios

  • Daily Operations: List notebooks, check status, view details, query flavors
  • Instance Lifecycle: Create, start, stop, update, delete notebook instances
  • Image Management: Save running instance as image, register/list/delete/sync custom images
  • Storage Management: Dynamically attach/detach storage to notebook instances
  • Lease Management: Query and renew notebook leases
  • Tag Management: Create, delete, query notebook tags

Prerequisites

  1. hcloud CLI installed and authenticated — Reference: https://support.huaweicloud.com/qs-hcli/hcli_02_003.html
  2. Huawei Cloud AK/SK configured via hcloud or environment variables
  3. ModelArts service enabled in the target region
  4. IAM permissions — See references/iam-policies.md

Workflow

Step 1: Identify the Operation

Determine which notebook operation the user needs based on their request:

User IntentOperation Category
Create/list/view/update/delete/start/stop notebookInstance Management
Query/renew leaseLease Management
Create/delete/query tagsTag Management
Save/register/list/delete/sync imageImage Management
Query flavors/clusters/featuresFlavor & Cluster
Attach/detach/list storageDynamic Storage

Step 2: Execute CLI Command

hcloud ModelArts  --cli-region={region} [--key=value ...]

{region} must be replaced with the actual region, e.g., cn-north-4. Do NOT hardcode the region.

Step 3: Handle Write Operations

For all write operations (Create/Update/Delete/Start/Stop/Attach/Detach/Register/Sync/Renew), prompt the user for confirmation before execution.


KooCLI Command Format Standard

hcloud ModelArts  --cli-region={region} [--key=value ...]
FeatureDescriptionExample
Service nameFixed: ModelArtsModelArts
Operation namePascalCaseListNotebooks, CreateNotebook
Region parameter--cli-region={region}--cli-region=cn-north-4
Simple parameter--key=value--id=xxx
Indexed parameter--key.1=value1--tags.1.key=env
project_idAuto-resolved if omittedUses configured project ID

Note: --project_id is auto-resolved from authentication credentials if omitted. Include it explicitly only when targeting a specific project.


Core Commands

All 31 CLI command examples across 7 functional domains are documented in a separate reference file.

📖 For detailed command syntax, parameters, and examples, read references/cli-command-examples.md

Quick Index

#DomainAPIsKey Operations
1Instance Management8CreateNotebook, ListNotebooks, ListAllNotebooks, ShowNotebook, UpdateNotebook, DeleteNotebook, StartNotebook, StopNotebook
2Lease Management2ShowLease, RenewLease
3Tag Management3ShowNotebookTags, CreateNotebookTags, DeleteNotebookTags
4Image Management9CreateImage, ListImage, RegisterImage, ShowImage, DeleteImage, SyncImage, ListImageGroup, DeleteImageGroup, UpdateImageGroup
5Flavor and Cluster4ListFlavors, ShowSwitchableFlavors, ListAuthoringClusters, ShowCluster
6Feature Query1ListFeatures
7Dynamic Storage4ListDynamicStorages, AttachDynamicStorage, ShowDynamicStorage, DetachDynamicStorage

When executing any command, always refer to the reference file for exact parameter names, required/optional flags, and usage patterns.


Parameter Confirmation

ParameterRequiredDescriptionExample
{region}YesHuawei Cloud regioncn-north-4, cn-east-3
{instance_id}Yes (most ops)Notebook instance UUIDxxx-xxx-xxx
{image_id}Create/ListImage UUIDxxx-xxx-xxx
{flavor_id}CreateFlavor ID for instancemodelarts.bm.4xlarge.pro
{resource_id}Tag opsResource ID for taggingxxx-xxx-xxx
{cluster_id}ShowClusterCluster IDxxx-xxx-xxx
{storage_id}Storage opsStorage IDxxx-xxx-xxx
{feature}ListFeaturesFeature nameNOTEBOOK
{project_id}No (auto)Project ID, auto-resolved if omittedOmit for default

SDK Fallback

If a CLI operation fails due to a CLI bug, fall back to SDK:

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkmodelarts.v1.modelarts_client import ModelArtsClient
from huaweicloudsdkmodelarts.v1.region.modelarts_region import ModelArtsRegion

credentials = BasicCredentials(ak="{AK}", sk="{SK}", project_id="{project_id}")
client = ModelArtsClient.new_builder() \
    .with_credentials(credentials) \
    .with_region(ModelArtsRegion.value_of("{region}")) \
    .build()

Reference Documents

DocumentDescription
references/cli-command-examples.mdDetailed CLI command syntax and examples for all 31 APIs
references/iam-policies.mdLeast-privilege IAM policies
references/verification-method.mdVerification and testing methods
references/dataflow-diagram.mdMermaid data flow diagram
references/acceptance-criteria.mdAcceptance criteria checklist
references/api-paths.mdREST API paths from SDK source
references/cli-installation-guide.mdCLI installation and authentication guide
references/known-issues.mdKnown issues and workarounds

Known Issues (Summary)

Full details: references/known-issues.md

#IssueKey Takeaway
1CLI omits EVS from volume.category enumUse --cli-jsonInput with body wrapper + explicit --project_id
2Storage category × ownership matrixEVS:MANAGED ✅, OBS/OBSFS:DEDICATED ✅, OBS/OBSFS:MANAGED ❌
3DEDICATED ownership requires pool_idQuery dedicated pools first, pass top-level pool_id
4OBS as data_volume silently failsUse OBS as main volume or use OBSFS as data_volume
5Bucket type (POSIX vs OBJECT) irrelevantBoth work with DEDICATED ownership
6OBSFS:MANAGED extended storage unsupportedUse DEDICATED for OBSFS
7OBS/OBSFS main volume needs dew_secret_nameStore AK/SK in DEW/CSMS secret
8OBS data volume requires mount_pathAlways specify valid path
9Image/flavor architecture mismatchMatch arch field between image and flavor
10--cli-jsonInput general workaroundMust wrap in {"body":{...}} + pass --project_id explicitly
11ShowLease duration is total, not remainingCalculate: remaining = (create_at + duration) - current_time
12ListImageGroup response field varies with --limitWithout limit: groups field; with limit: data field. Parse both
13AttachDynamicStorage only supports POSIX bucketsOBJECT buckets rejected with ModelArts.6772; use obsutil stat to verify

Notes

  • All 31 API interfaces are available via hcloud ModelArts CLI
  • SDK fallback available via huaweicloudsdkmodelarts v1 if CLI encounters issues
  • Region is specified via --cli-region and should NOT be hardcoded
  • --project_id is auto-resolved from credentials if omitted
  • All write operations (Create/Update/Delete/Start/Stop/Attach/Detach/Register/Sync/Renew) require user confirmation before execution
  • API paths verified from SDK source _http_info resource_path — no inferred endpoints

Related skills

Manage Huawei Cloud ModelArts dedicated resource pools (专属资源池) and node pools through full lifecycle operations via hcloud CLI. Covers 53 operations across 10 functional domains: resource pool management, pool nodes, node pool management, network resources, tag management, plugin management, jobs/tasks, scheduled events, OS configuration, and resource flavor/event queries. Includes BSS on-demand pricing inquiry before chargeable operations (create/expand) to inform users of costs. All write operations require user confirmation. Triggers include: "资源池", "专属资源池", "resource pool", "创建资源池", "查询资源池", "删除资源池", "更新资源池", "资源池监控", "资源池节点", "pool node", "节点池", "node pool", "资源池网络", "pool network", "资源池标签", "pool tags", "插件", "plugin", "工作负载", "workload", "定时事件", "scheduled event", "OS配置", "规格列表", "ModelArts resource pool", "manage resource pool", "询价", "pricing", "按需价格", "价格查询".

Manage Huawei Cloud ModelArts training jobs and related resources through full lifecycle operations via hcloud CLI. Covers 52 API interfaces across 8 functional domains: training job management, algorithm management, training job tags, training experiments, training job events, model import, auto search (hyperparameter tuning), and training image save. All write operations require user confirmation before execution. Triggers include: "ModelArts training", "训练作业", "模型训练", "创建训练作业", "查询训练作业", "停止训练作业", "删除训练作业", "算法管理", "超参配置", "training job", "training management", "create training", "ModelArts 训练", "训练实验", "自动搜索", "超参调优".

1 installs

Provides guidance for Huawei Cloud KooCLI command-line tool operations. Covers KooCLI installation, IAM authentication configuration, access credential confi...

by huaweicloud-skills-team1 installs

Query the total number of Huawei Cloud services available through KooCLI offline metadata. Returns the count of all supported cloud services from the cached service catalog. Triggers include: "how many Huawei Cloud services", "count Huawei Cloud services", "华为云服务总数", "华为云有多少个服务", "查询华为云服务数量".

1 installs

Queries Huawei Cloud Cloud Connect (CC) resources via hcloud CLI. Covers cloud connection instances (single + list), bandwidth packages (single + list), inter-region bandwidths (single + list), network instances (single + list), cloud connection routes (single + list), and cross-account authorisations (granted + received). No write operations. Use this skill when the user needs to inspect cross-cloud connectivity topology, check bandwidth package status, review inter-region bandwidth allocation, query network instances attached to a cloud connection, troubleshoot routing in Cloud Connect, or audit cross-account authorisation relationships (who authorised whom). Triggers: 云连接, CC, Cloud Connect, 带宽包, bandwidth package, 域间带宽, inter-region bandwidth, 网络实例, network instance, 路由查询, cloud connection route, 跨云网络, cross-cloud connectivity, 授权, authorisation, 被授权, permission, 跨账号, cross-account.

Huawei Cloud UCS cluster onboarding, lifecycle, and fleet management via hcloud CLI. Register/query/remove clusters, manage fleet groups, obtain kubeconfig, check quotas. Trigger: "UCS cluster onboarding", "UCS 集群纳管", "UCS fleet", "UCS 舰队", "UCS kubeconfig", "UCS federation", "UCS 联邦", "UCS 配额", "cluster lifecycle", "纳管集群", "集群管理"

by huaweicloud-skills-team

More from huaweicloud-skills-team

Browse all skills

Manage Huawei Ascend NPUs with natural language commands that translate to npu-smi, locally or over SSH.

by huaweicloud-skills-team7 installs

Deploy and test LLM, VL, Embedding, and Rerank models on Huawei Cloud Ascend 910B DevServer with single- or dual-node topologies.

by huaweicloud-skills-team7 installs

Read-only queries against Huawei Cloud resources for inventory, verification, and parameter discovery.

by huaweicloud-skills-team6 installs

Query Huawei Cloud IAM resources (users, groups, policies, agencies, AK/SK, MFA, security settings) read-only via local Python SDK.

by huaweicloud-skills-team6 installs