Huawei Cloud ModelArts Notebook Management

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

Overview

hcloud

Architecture

User Request → Agent → hcloud ModelArts <Operation> --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

Scope

• 推理服务（在线服务、批量服务）— 使用推理服务管理 skill
• DevServer（开发环境）— 使用 DevServer 管理 skill
• 模型管理（导入/导出/发布模型）— 使用模型管理 skill
• 训练作业（创建/管理训练任务）— 使用训练作业管理 skill
• 自动搜索、超参调优 — 使用自动搜索 skill

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 (see Security & Credential Check below)
3. ModelArts service enabled in the target region
4. IAM permissions — See references/iam-policies.md

Security & Credential Check

⚠️ CRITICAL: This section defines the agent's security boundary. Follow it strictly.

🔒 Security Rules (MANDATORY)

• 🚫 NEVER read, echo, or print AK/SK values (e.g.,

  cat ~/.hcloud/config.json

  ,

  echo $HW_ACCESS_KEY

  is FORBIDDEN)
• 🚫 NEVER read or cat credential files such as

  ~/.hcloud/config.json

  or any file that may contain secrets
• 🚫 NEVER ask the user to input AK/SK directly in the conversation or command line
• 🚫 NEVER execute

  hcloud configure set --cli-access-key=... --cli-secret-key=...

  — credential configuration is the user's responsibility, done outside the agent session
• 🚫 NEVER pass

  --cli-access-key

  /

  --cli-secret-key

  on every API call — they will be exposed in process listings (

  ps aux

  ) for the entire request duration
• ✅ ALWAYS use

  hcloud configure list

  to check credential status (presence check only, not values)
• ✅ If no valid profile exists, STOP and instruct the user to configure credentials outside this session
• ✅ Recommend using IAM user with minimal permissions instead of main account

✅ Agent Credential Check (the ONLY acceptable check)

# Step 1: Check credential status — presence only, not values
hcloud configure list

• ✅ Expected: Shows a valid profile with

  mode: AKSK

• ❌ If empty/invalid → Guide the user with the 3-step process below:
  Step-by-step guidance (copy-paste for the user):

  "No valid credentials found. Please follow these 3 steps in your terminal:"

  ① Get your AK/SK Log in to Huawei Cloud Console → IAM → Access Keys. If you don't have one, click "Create Access Key" and save it securely.

  ② Run this in your terminal (one-time setup):

  bash

  hcloud configure set --cli-access-key=<YOUR_AK> --cli-secret-key=<YOUR_SK>

  (Replace

  <YOUR_AK>

  and

  <YOUR_SK>

  with the values from step ①)

  ③ Come back and tell me "configured", I'll verify it works.

  Note: The

  configure set

  command stores your credentials in

  ~/.hcloud/config.json

  . After that, all hcloud commands use them automatically — no need to pass AK/SK again.

  Agent: DO NOT execute any

  configure set

  command yourself.

🔧 User's Responsibility (for documentation, NOT agent execution)

# One-time setup — run this in your terminal, NOT in the agent chat
HISTCONTROL=ignorespace
 hcloud configure set --cli-access-key=<YOUR_AK> --cli-secret-key=<YOUR_SK>

⚠️ Note: hcloud CLI does NOT read

HW_ACCESS_KEY

/

HW_SECRET_KEY

environment variables (those are for Python SDK only).

hcloud configure set

is the only supported credential configuration method.

Workflow

Step 1: Identify the Operation

Step 2: Execute CLI Command

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

{region}

must be replaced with the actual region, e.g.,

cn-north-4

. Do NOT hardcode the region.

Step 2.5: Consult Known Issues (Write Operations Only)

Before executing any write operation, read references/known-issues.md and check for known pitfalls, parameter corrections, and required workarounds for the target API.

--volume.category=EVS

--cli-jsonInput

{"body":{...}}

--project_id

flavor_id

--flavor

volume.size

--volume.capacity

ownership=PRIVATE

MANAGED

DEDICATED

RUNNING

mount_path

/data/

/

arch

X86_64

AARCH64

type

timing

idle

This step is mandatory for all write operations. Skipping it may result in CLI parameter errors or API failures that are already documented.

Step 3: Handle Write Operations

删除类操作交互指引：当用户请求删除标签（DeleteNotebookTags）、删除镜像分组（DeleteImageGroup）等操作但未指定具体对象时，必须先查询当前对象列表（如

ShowNotebookTags

/

ListImageGroup

），向用户展示并确认要删除哪个对象，确认后再执行。避免因上下文不明确导致误删。

KooCLI Command Format Standard

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

ModelArts

ModelArts

ListNotebooks

CreateNotebook

--cli-region={region}

--cli-region=cn-north-4

--key=value

--id=xxx

--key.1=value1

--tags.1.key=env

Note:

--project_id

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

Core Commands

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

Quick Index

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

Parameter Confirmation

{region}

cn-north-4

cn-east-3

{instance_id}

xxx-xxx-xxx

{image_id}

xxx-xxx-xxx

{flavor_id}

modelarts.bm.4xlarge.pro

{resource_id}

xxx-xxx-xxx

{cluster_id}

xxx-xxx-xxx

{storage_id}

xxx-xxx-xxx

{feature}

NOTEBOOK

{project_id}

SDK Fallback

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

Known Issues (Summary)

Full details: references/known-issues.md

volume.category

--cli-jsonInput

body

--project_id

pool_id

pool_id

data_volume

volume

data_volume

dew_secret_name

mount_path

arch

--cli-jsonInput

{"body":{...}}

--project_id

ShowLease

remaining = (create_at + duration) - current_time

ListImageGroup

--limit

groups

data

AttachDynamicStorage

ModelArts.6772

obsutil stat

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 (but must be explicit when using

  --cli-jsonInput

  )
• All write operations (Create/Update/Delete/Start/Stop/Attach/Detach/Register/Sync/Renew) require user confirmation before execution
• Chargeable operations (CreateNotebook, StartNotebook) require BSS pricing inquiry to inform users of costs before execution
• API paths verified from SDK source

  _http_info

  resource_path

  — no inferred endpoints
• No hardcoded AK/SK in any file — credentials managed by hcloud via

  hcloud configure list/set