/alibabacloud-pai-dsw-manage

name: alibabacloud-pai-dsw-manage
description: |
  Manage the full lifecycle of Alibaba Cloud PAI DSW (Data Science Workshop) instances — create, update, query, list, start, stop, and look up ECS specs.
  Triggers: PAI DSW, DSW instance, create instance, start instance, stop instance, update instance, query instance, instance list, ECS spec, CreateInstance, UpdateInstance, GetInstance, ListInstances, StartInstance, StopInstance, ListEcsSpecs

PAI DSW Instance Management

Manage the full lifecycle of Alibaba Cloud PAI DSW (Data Science Workshop) instances — from provisioning through configuration changes, status monitoring, and start/stop operations. Also supports querying available ECS compute specs.

**Architecture**: `PAI Workspace + DSW Instance + ECS Spec + Image + VPC + Dataset`

**API Version**: `pai-dsw/2022-01-01`

---

Installation

> **Pre-check: Aliyun CLI >= 3.3.3 required** > > Run `aliyun version` to verify >= 3.3.3. If not installed or version too low, > run `curl -fsSL https://aliyuncli.alicdn.com/setup.sh | bash` to update, > or see [`references/cli-installation-guide.md`](references/cli-installation-guide.md) for installation instructions.

> **Pre-check: Aliyun CLI plugin update required** > [MUST] run `aliyun configure set --auto-plugin-install true` to enable automatic plugin installation. > [MUST] run `aliyun plugin update` to ensure that any existing plugins are always up-to-date.

# macOS (recommended)
brew install aliyun-cli

# Verify version (>= 3.3.3)
aliyun version

# Enable automatic plugin installation
aliyun configure set --auto-plugin-install true

# Update existing plugins
aliyun plugin update

# Install pai-dsw plugin
aliyun plugin install --names pai-dsw

**[MUST] CLI User-Agent** — Every `aliyun` CLI command invocation must include: `--user-agent AlibabaCloud-Agent-Skills/alibabacloud-pai-dsw-manage`

---

Authentication

> **Pre-check: Alibaba Cloud Credentials Required** > > **Security Rules:** > - **NEVER** read, echo, or print AK/SK values (e.g., `echo $ALIBABA_CLOUD_ACCESS_KEY_ID` is FORBIDDEN) > - **NEVER** ask the user to input AK/SK directly in the conversation or command line > - **NEVER** use `aliyun configure set` with literal credential values > - **ONLY** use `aliyun configure list` to check credential status > > ```bash > aliyun configure list > ``` > Check the output for a valid profile (AK, STS, or OAuth identity). > > **If no valid profile exists, STOP here.** > 1. Obtain credentials from [Alibaba Cloud Console](https://ram.console.aliyun.com/manage/ak) > 2. Configure credentials **outside of this session** (via `aliyun configure` in a terminal or environment variables in a shell profile) > 3. Return and retry after `aliyun configure list` shows a valid profile

---

RAM Permissions

See [`references/ram-policies.md`](references/ram-policies.md) for the complete permission list and minimum-privilege policy.

> **[MUST] Permission Failure Handling:** When any command or API call fails due to permission errors at any point during execution, follow this process: > 1. Read `references/ram-policies.md` to get the full list of permissions required by this skill > 2. Use the `ram-permission-diagnose` skill to guide the user through requesting the necessary permissions > 3. Pause and wait until the user confirms that the required permissions have been granted

---

Parameter Confirmation

> **IMPORTANT: Parameter Confirmation** — Before executing any command or API call, ALL user-customizable parameters (e.g., RegionId, instance names, CIDR blocks, passwords, domain names, resource specifications, etc.) MUST be confirmed with the user. Do NOT assume or use default values without explicit user approval.

| Parameter | Required | Description | Default | |---|---|---|---| | `WorkspaceId` | Required | PAI workspace ID | None — user must provide | | `InstanceName` | Required | Instance name (letters, digits, underscores only; max 27 chars) | None — user must provide | | `EcsSpec` | Required (post-paid) | ECS compute spec, e.g., `ecs.c6.large`. Query via `list-ecs-specs` | None | | `ImageId` | Mutually exclusive with `ImageUrl` | Image ID from PAI console | None | | `ImageUrl` | Mutually exclusive with `ImageId` | Container image URL. See [`references/common-images.md`](references/common-images.md) for common official images | None | | `RegionId` | Required | Region, e.g., `cn-hangzhou`, `cn-shanghai` | None — user must confirm | | `Accessibility` | Optional | Visibility scope: `PUBLIC` (all workspace users) or `PRIVATE` | `PRIVATE` | | `InstanceId` | Required (update/get/start/stop) | Instance ID (`dsw-xxxxx` format) | None | | `VpcId` | Optional | VPC ID for private network access | None | | `VSwitchId` | Optional | VSwitch ID within the VPC | None | | `SecurityGroupId` | Optional | Security group ID | None | | `AcceleratorType` | Required (spec query) | Accelerator type: `CPU` or `GPU` | None — user must confirm | | `Datasets` | Optional | Dataset mounts in CLI list format: `DatasetId=<> MountPath=<> MountAccess=RO|RW` | None — **user must confirm, no default** | | `--read-timeout` | Optional | CLI read timeout in seconds (for long-running operations) | `10` | | `--connect-timeout` | Optional | CLI connection timeout in seconds | `10` |

> **How to get WorkspaceId**: If the user doesn't know their workspace ID, run: > ```bash > aliyun aiworkspace list-workspaces --region <region> --user-agent AlibabaCloud-Agent-Skills/alibabacloud-pai-dsw-manage > ``` > This returns all workspaces the user has access to. Select the appropriate one based on `WorkspaceName` or ask the user to confirm. > > Reference: [Create and Manage Workspaces](https://help.aliyun.com/zh/pai/user-guide/create-and-manage-workspaces)

---

Core Workflow

> Full command syntax and parameter details: [`references/related-commands.md`](references/related-commands.md).

1. Query Available ECS Specs

Run `aliyun pai-dsw list-ecs-specs --accelerat