Alibabacloud Cms Dataset

CMS Dataset Lifecycle Management and Querying

Manage CloudMonitor (CMS) dataset resources — list, inspect, create, update, delete datasets and execute dataset-level queries — using the aliyun CLI.

Architecture: CMS Workspace + Dataset (Schema + Fields) + ExecuteQuery

---

Installation

Install Aliyun CLI

Run aliyun version to verify if version >= 3.3.3. If not installed or outdated, follow the doc references/cli-installation-guide.md to install or update.

Ensure plugins up-to-date

[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.

---

AI-Mode Lifecycle

At the start of the Core Workflow (before any CLI invocation):

[MUST] Enable AI-Mode — AI-mode is required for Agent Skill execution.

```bash

aliyun configure ai-mode enable

aliyun configure ai-mode set-user-agent --user-agent "AlibabaCloud-Agent-Skills/alibabacloud-cms-dataset"

```

[MUST] Disable AI-Mode at EVERY exit point — Before delivering the final response for ANY reason, always disable AI-mode first. This applies to ALL exit paths: workflow success, workflow failure, error/exception, user cancellation, session end, or any other scenario where no further CLI commands will be executed.

```bash

aliyun configure ai-mode disable

```

---

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

2. Configure credentials outside of this session (via aliyun configure in terminal or environment variables in shell profile)

3. Return and re-run after aliyun configure list shows a valid profile

---

RAM Policy

See references/ram-policies.md for the full permission list.

Minimum required actions: cms:ListDatasets, cms:GetDataset, cms:CreateDataset, cms:UpdateDataset, cms:DeleteDataset, cms:ExecuteQuery.

[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 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.

---

Naming Rules

Dataset names and schema field names must satisfy:

• Length: 4-63 characters
• Start with a lowercase letter
• Only lowercase letters, digits, and underscores
• No leading/trailing underscore, no consecutive underscores

Regex: ^[a-z](?!.*__)[a-z0-9_]{2,61}[a-z0-9]$

Invalid names must NOT be silently normalized. Ask the user for a valid replacement.

---

Core Workflow

[CRITICAL] Product Binding: All dataset operations in this skill use the `cms` product ONLY.

The correct command pattern is aliyun cms <action> --api-version 2024-03-30.

DO NOT use any other product for dataset operations — dataworks, adb, sls, maxcompute, opensearch, pai, dashvector, or any other service are WRONG for this scenario.

If a command fails, check parameters and permissions — do NOT switch to a different product.

All commands use --api-version 2024-03-30. Do not pass --endpoint by default. Use --region (not --region-id) when specifying a region.

0. Verify Workspace Exists

[MUST] Before executing any dataset operation, call get-workspace to verify the workspace exists. Do NOT skip this step or use ListDatasets to infer workspace existence.

aliyun cms get-workspace --api-version 2024-03-30 \
  --workspace <workspace>

If the workspace does not exist (returns error), create it via put-workspace:

aliyun cms put-workspace --api-version 2024-03-30 \
  --workspace-name <workspace> \
  --sls-project <sls-project>

--sls-project is required. If the user does not specify one, use the same value as the workspace name.

1. List Datasets

aliyun cms list-datasets --api-version 2024-03-30 \
  --workspace <workspace> \
  [--dataset-name <filter>] \
  [--max-results <n>] \
  [--next-token <token>]

2. Get Dataset

aliyun cms get-dataset --api-version 2024-03-30 \
  --workspace <workspace> \
  --dataset-name <dataset-name>

3. Create Dataset

Safety: Before creating, check whether the dataset already exists via ListDatasets. If the dataset already exists, inform the user and ask whether to proceed (the API will return an error for duplicates). Always call CreateDataset when the user requests creation — do not silently skip it.

Pass the schema JSON directly as a single-quoted string:

aliyun cms create-dataset --api-version 2024-03-30 \
  --workspace <workspace> \
  --dataset-name <dataset-name> \
  --schema '{"message_text":{"type":"text","chn":true,"embedding":"text-embedding-v4"},"service_name":{"type":"text","chn":false}}' \
  [--description "<description>"]

Schema rules:

• The --schema value is the field definitions object directly (not wrapped in an API body).
• Each top-level key is a field name. Each value has: type, optional chn, optional embedding, optional jsonKeys.
• Only type: "text" fields may enable embedding. Reject embedding on non-text fields.
• jsonKeys defines nested JSON key structures. Nested keys support type and chn only (no embedding):

{
  "event_data": {
    "type": "text",
    "chn": false,
    "jsonKeys": {
      "source": {
        "type": "text",
        "chn": false
      },
      "message": {
        "type": "text",
        "chn": true
      }
    }
  }
}

4. Update Dataset

Safety: Read and show the current description before updating.

Limitation: UpdateDataset can only modify the description. Schema cannot be updated through this API. If the user needs to change the schema, they must delete and recreate the dataset.

# Show current state
aliyun cms get-dataset --api-version 2024-03-30 \
  --workspace <workspace> --dataset-name <dataset-name>

# Update after user confirms
aliyun cms update-dataset --api-version 2024-03-30 \
  --workspace <workspace> \
  --dataset-name <dataset-name> \
  --description "<new-description>"

5. Delete Dataset

Safety: Read and show the dataset, then ask for explicit confirmation identifying workspace and dataset name before deleting.

# Show dataset to confirm
aliyun cms get-dataset --api-version 2024-03-30 \
  --workspace <workspace> --dataset-name <dataset-name>

# Delete after explicit confirmation
aliyun cms delete-dataset --api-version 2024-03-30 \
  --workspace <workspace> \
  --dataset-name <dataset-name>

6. Execute Query

Safety: When possible, inspect the dataset schema first via GetDataset so field names come from the actual schema.

aliyun cms execute-query --api-version 2024-03-30 \
  --workspace <workspace> \
  --dataset-name <dataset-name> \
  --type SQL \
  --query '<query>'

• --type is a required placeholder. Always pass SQL.
• If the user provides a complete query, preserve it except for safe shell quoting.
• Natural-language to query: When the user describes an analysis intent in natural language instead of providing a query, first call GetDataset to retrieve the actual schema and field names, then generate a query based on those field names. Never guess field names without inspecting the schema.
• Present the full JSON response first, then summarize: progress, returned rows, affected rows, and elapsed time.

---

Success Verification

See references/verification-method.md for step-by-step verification commands for each operation.

---

Cleanup

To remove a dataset created during this session:

aliyun cms delete-dataset --api-version 2024-03-30 \
  --workspace <workspace> \
  --dataset-name <dataset-name>

---

Output Expectations

• Show complete JSON first for any API response.
• Then provide a short human-readable summary.
• For write previews: include workspace, dataset name, region, description, and full schema.
• For query results: include progress, row count, affected rows, and elapsed time.

---

Command Tables

See references/related-commands.md for the full command reference.

---

Best Practices

1. Always specify --api-version 2024-03-30 — the default CMS version (2019-01-01) does not support dataset operations. 2. Validate dataset names and field names against the naming regex before calling CreateDataset. 3. Use GetDataset to inspect schema before generating queries — use actual field names, not guesses. 4. Pass schema JSON directly as a single-quoted string to avoid shell quoting issues. 5. Always confirm write operations (Create, Update, Delete) with the user before execution. 6. Check dataset existence before creating to avoid duplicates. 7. Use --region (not --region-id) when specifying a region explicitly. 8. Do not pass --endpoint unless explicitly required; if needed, use cms.<region>.aliyuncs.com. 9. For ExecuteQuery, always pass --type SQL as a required placeholder. 10. Prefer inline JSON for --schema to avoid temporary file management. 11. Never switch products. If a cms command fails, debug parameters/permissions — do not try dataworks, adb, sls, maxcompute, or other products. The "workspace" in this skill is a CMS workspace, not a DataWorks/SLS/MaxCompute project. 12. Set explicit timeouts. Use --read-timeout 30 --connect-timeout 10 for metadata operations (list/get/create/update/delete). For ExecuteQuery use --read-timeout 120 --connect-timeout 10 as queries may take longer.

---

Reference Links

Acceptance Criteria: alibabacloud-cms-dataset

Scenario: CMS Dataset Lifecycle Management and Querying Purpose: Skill testing acceptance criteria

---

Correct CLI Command Patterns

1. Product — cms

CORRECT

aliyun cms list-datasets --api-version 2024-03-30 ...

INCORRECT

aliyun CMS list-datasets ...        # Wrong case
aliyun cloudmonitor list-datasets ... # Wrong product name

2. API Version — 2024-03-30

CORRECT

aliyun cms list-datasets --api-version 2024-03-30

INCORRECT

aliyun cms list-datasets                          # Missing api-version, defaults to 2019-01-01
aliyun cms list-datasets --api-version 2019-01-01 # Wrong version, dataset APIs not available

3. Commands — Plugin Mode (kebab-case)

CORRECT

aliyun cms list-datasets ...
aliyun cms get-dataset ...
aliyun cms create-dataset ...
aliyun cms update-dataset ...
aliyun cms delete-dataset ...
aliyun cms execute-query ...

INCORRECT

aliyun cms ListDatasets ...    # PascalCase API name, not plugin mode
aliyun cms listDatasets ...    # camelCase, not plugin mode
aliyun cms list_datasets ...   # snake_case, not kebab-case

4. Parameters — kebab-case naming

CORRECT

--workspace <value>
--dataset-name <value>
--max-results <value>
--next-token <value>
--api-version 2024-03-30
--description <value>
--schema <value>
--type SQL
--query '<value>'
--region cn-hangzhou

INCORRECT

--datasetName <value>    # camelCase, not kebab-case
--region-id cn-hangzhou  # Wrong: use --region for CMS dataset commands
--endpoint <value>       # Do not pass --endpoint by default

5. Schema Format

CORRECT — Schema value is the field definitions object

{
  "message_text": {
    "type": "text",
    "chn": true
  },
  "service_name": {
    "type": "text",
    "chn": false
  }
}

INCORRECT — Schema wraps in API body structure

{
  "datasetName": "app_logs",
  "schema": {
    "message_text": {
      "type": "text"
    }
  }
}

6. Schema Passing

CORRECT

aliyun cms create-dataset --api-version 2024-03-30 \
  --workspace <workspace> \
  --dataset-name <name> \
  --schema '{"message_text":{"type":"text","chn":true}}'

INCORRECT

# Unquoted JSON — shell parsing issues
aliyun cms create-dataset --schema {"field": {"type": "text"}}

7. Dataset Naming Rules

CORRECT

app_logs           # 4+ chars, lowercase, starts with letter
service_metric_01  # Digits allowed after first char
trace_id           # Single underscores allowed

INCORRECT

AppLogs      # Uppercase not allowed
app-logs     # Hyphens not allowed
app__logs    # Consecutive underscores not allowed
_app_logs    # Cannot start with underscore
app_logs_    # Cannot end with underscore
app          # Too short (< 4 chars)

Regex: ^[a-z](?!.*__)[a-z0-9_]{2,61}[a-z0-9]$

8. ExecuteQuery — Type Parameter

CORRECT

aliyun cms execute-query --api-version 2024-03-30 \
  --workspace <workspace> --dataset-name <name> \
  --type SQL --query 'SELECT count(1) FROM "datasetname"'

INCORRECT

# Missing --type parameter
aliyun cms execute-query --api-version 2024-03-30 \
  --workspace <workspace> --dataset-name <name> \
  --query 'SELECT count(1) FROM "datasetname"'

9. Embedding Constraint

CORRECT — embedding only on text fields

{
  "message_text": {
    "type": "text",
    "chn": true,
    "embedding": "text-embedding-v4"
  }
}

INCORRECT — embedding on non-text field

{
  "count_field": {
    "type": "long",
    "embedding": "text-embedding-v4"
  }
}

10. jsonKeys Nested Structure

CORRECT — nested keys with type and chn only

{
  "event_data": {
    "type": "text",
    "chn": false,
    "jsonKeys": {
      "source": {
        "type": "text",
        "chn": false
      },
      "message": {
        "type": "text",
        "chn": true
      }
    }
  }
}

INCORRECT — embedding inside jsonKeys (not supported)

{
  "event_data": {
    "type": "text",
    "jsonKeys": {
      "source": {
        "type": "text",
        "embedding": "text-embedding-v4"
      }
    }
  }
}

11. Endpoint Usage

CORRECT

# No endpoint by default — let CLI resolve it
aliyun cms list-datasets --api-version 2024-03-30 --workspace <workspace>

# Only when explicitly required
--endpoint cms.cn-hangzhou.aliyuncs.com

INCORRECT

# Wrong endpoint format
--endpoint metrics.cn-hangzhou.aliyuncs.com

12. Safety — Write Operation Confirmation

CORRECT

• Before CreateDataset: check if dataset already exists via ListDatasets
• Before UpdateDataset: show current and new description via GetDataset
• Before DeleteDataset: show dataset details and ask for explicit confirmation

INCORRECT

• Creating a dataset without checking for duplicates
• Deleting a dataset without user confirmation
• Updating description without showing the current value

13. Product Binding — ONLY use cms

CORRECT

aliyun cms list-datasets --api-version 2024-03-30 --workspace <workspace>
aliyun cms create-dataset --api-version 2024-03-30 --workspace <workspace> ...

INCORRECT — using wrong products

aliyun dataworks CheckDatasetExistence ...   # Wrong product
aliyun adb DescribeTables ...                # Wrong product
aliyun sls POST /logstores ...               # Wrong product
aliyun maxcompute POST /projects/.../tables  # Wrong product
aliyun opensearch ...                        # Wrong product

CMS dataset operations belong to the cms product exclusively. The workspace parameter is a CMS workspace ID, not a DataWorks workspace, SLS project, or MaxCompute project. If a command fails, fix parameters or permissions — never switch to a different product.

14. Credential Handling

CORRECT

aliyun configure list   # Check credential status

INCORRECT

echo $ALIBABA_CLOUD_ACCESS_KEY_ID    # NEVER print AK/SK
aliyun configure set --access-key-id LTAI... --access-key-secret 8d...  # NEVER hardcode in agent

Aliyun CLI Installation & Configuration Guide

Complete guide for installing and configuring Aliyun CLI.

Aliyun CLI 3.3.3+: Supports installing and using all published Alibaba Cloud product plugins. Make sure to upgrade to 3.3.3 or later for full plugin ecosystem coverage.

Installation

macOS

Using Homebrew (Recommended)

brew install aliyun-cli
# Upgrade to latest
brew upgrade aliyun-cli

# Verify version (>= 3.3.3)
aliyun version

Using Binary

# Download
wget https://aliyuncli.alicdn.com/aliyun-cli-macosx-latest-amd64.tgz

# Extract
tar -xzf aliyun-cli-macosx-latest-amd64.tgz

# Move to PATH
sudo mv aliyun /usr/local/bin/

# Verify
aliyun version

Linux

Debian/Ubuntu

# Download
wget https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-amd64.tgz

# Extract and install
tar -xzf aliyun-cli-linux-latest-amd64.tgz
sudo mv aliyun /usr/local/bin/

# Verify
aliyun version

CentOS/RHEL

# Download
wget https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-amd64.tgz

# Extract and install
tar -xzf aliyun-cli-linux-latest-amd64.tgz
sudo mv aliyun /usr/local/bin/

# Verify
aliyun version

ARM64 Architecture

# Download ARM64 version
wget https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-arm64.tgz

# Extract and install
tar -xzf aliyun-cli-linux-latest-arm64.tgz
sudo mv aliyun /usr/local/bin/

Windows

Using Binary 1. Download from: https://aliyuncli.alicdn.com/aliyun-cli-windows-latest-amd64.zip 2. Extract the ZIP file 3. Add the directory to your PATH environment variable 4. Open new Command Prompt or PowerShell 5. Verify: aliyun version

Using PowerShell

# Download
Invoke-WebRequest -Uri "https://aliyuncli.alicdn.com/aliyun-cli-windows-latest-amd64.zip" -OutFile "aliyun-cli.zip"

# Extract
Expand-Archive -Path aliyun-cli.zip -DestinationPath C:\aliyun-cli

# Add to PATH (requires admin privileges)
$env:Path += ";C:\aliyun-cli"
[Environment]::SetEnvironmentVariable("Path", $env:Path, [System.EnvironmentVariableTarget]::Machine)

# Verify
aliyun version

Quick Setup

curl -fsSL https://aliyuncli.alicdn.com/setup.sh | bash
aliyun version

Configuration

Access Key Mode

aliyun configure set \
  --mode AK \
  --access-key-id <your-access-key-id> \
  --access-key-secret <your-access-key-secret> \
  --region cn-hangzhou

Where to Get Access Keys: https://ram.console.aliyun.com/manage/ak

Environment Variables

export ALIBABA_CLOUD_ACCESS_KEY_ID=your_access_key_id
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=your_access_key_secret
export ALIBABA_CLOUD_REGION_ID=cn-hangzhou

Managing Profiles

aliyun configure list                      # List all profiles
aliyun configure set --current projectA    # Switch default profile
aliyun ecs describe-instances --profile projectA  # Use specific profile

References

• Official Documentation: https://help.aliyun.com/zh/cli/
• RAM Console: https://ram.console.aliyun.com/
• Access Key Management: https://ram.console.aliyun.com/manage/ak

RAM Policies: alibabacloud-cms-dataset

Required RAM permissions for CMS Dataset operations (API version 2024-03-30).

Permission List

Minimum Policy Document

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "cms:ListDatasets",
        "cms:GetDataset",
        "cms:CreateDataset",
        "cms:UpdateDataset",
        "cms:DeleteDataset",
        "cms:ExecuteQuery"
      ],
      "Resource": "*"
    }
  ]
}

Read-Only Policy

For users who only need to list, inspect, and query datasets:

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "cms:ListDatasets",
        "cms:GetDataset",
        "cms:ExecuteQuery"
      ],
      "Resource": "*"
    }
  ]
}

Notes

• All actions are scoped to the CMS service (cms:*).
• Resource-level authorization is supported. Replace "*" with specific workspace ARNs to restrict scope.
• Attach the policy to the RAM user or role used by the aliyun CLI profile.

Related CLI Commands: alibabacloud-cms-dataset

All CMS Dataset CLI commands (API version 2024-03-30). All commands require --api-version 2024-03-30.

Command Reference

Parameter Details

Common Parameters

ListDatasets

GetDataset / DeleteDataset

CreateDataset

UpdateDataset

ExecuteQuery

Example Commands

# List all datasets
aliyun cms list-datasets --api-version 2024-03-30 --workspace <workspace>

# Get dataset details
aliyun cms get-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

# Create dataset
aliyun cms create-dataset --api-version 2024-03-30 --workspace <workspace> \
  --dataset-name <name> --schema '{"field":{"type":"text","chn":true}}' --description "desc"

# Update description
aliyun cms update-dataset --api-version 2024-03-30 --workspace <workspace> \
  --dataset-name <name> --description "new description"

# Delete dataset
aliyun cms delete-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

# Execute query
aliyun cms execute-query --api-version 2024-03-30 --workspace <workspace> \
  --dataset-name <name> --type SQL --query 'SELECT count(1) FROM "datasetname"'

Verification Method: alibabacloud-cms-dataset

Steps to verify each workflow action was successful.

1. List Datasets

Command:

aliyun cms list-datasets --api-version 2024-03-30 --workspace <workspace>

Success criteria:

• HTTP 200 response
• Response contains datasets array
• Each entry has datasetName, description, and metadata

Verification:

• Check that datasets is present and is an array (may be empty for new workspaces)

2. Get Dataset

Command:

aliyun cms get-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

Success criteria:

• HTTP 200 response
• Response contains datasetName, schema, and description
• schema contains the expected field definitions

Verification:

• Confirm datasetName matches the requested name
• Confirm schema field keys match expected fields

3. Create Dataset

Pre-check:

aliyun cms list-datasets --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

• Verify dataset does NOT already exist

Command:

aliyun cms create-dataset --api-version 2024-03-30 --workspace <workspace> \
  --dataset-name <name> --schema '{"field":{"type":"text","chn":true}}'

Success criteria:

• HTTP 200 response with no error

Post-verification:

aliyun cms get-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

• Confirm the dataset exists and schema matches what was submitted

4. Update Dataset

Pre-check:

aliyun cms get-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

• Record current description

Command:

aliyun cms update-dataset --api-version 2024-03-30 --workspace <workspace> \
  --dataset-name <name> --description "new description"

Post-verification:

aliyun cms get-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

• Confirm description has been updated to the new value

5. Delete Dataset

Pre-check:

aliyun cms get-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

• Confirm the dataset exists and show details to user for confirmation

Command:

aliyun cms delete-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

Post-verification:

aliyun cms list-datasets --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

• Confirm the dataset no longer appears in the list

6. Execute Query

Pre-check:

aliyun cms get-dataset --api-version 2024-03-30 --workspace <workspace> --dataset-name <name>

• Confirm the dataset exists and inspect schema for valid field names

Command:

aliyun cms execute-query --api-version 2024-03-30 --workspace <workspace> \
  --dataset-name <name> --type SQL --query '<query>'

Success criteria:

• HTTP 200 response
• Response contains requestId, meta, and data
• meta.progress indicates query completion status

Verification:

• Check meta.affectedRows and meta.count for expected row counts
• Check meta.elapsedMillisecond for reasonable execution time
• Verify data contains the expected result structure