Skip to main content

Overview

ecctl is an Agent-first command-line controller for Alibaba Cloud compute, container, and network resources. It exposes a consistent command shape for resource operations:

ecctl <product> <resource> <action> [args] [flags]

Every modeled command exposes a structured spec — required parameters, risk level, dry-run, idempotency, and waiters — that an agent or script can read before execution. Output is JSON-first and errors are structured, so agents and scripts read results and failures the same way. See Concepts for this model.

The current public command surface covers ACK, ECS, VPC, and Lingjun resources. Use schema before running a cloud operation:

ecctl schema --list
ecctl schema --list ecs
ecctl schema ecs.instance.create --brief

These are local discovery commands; they do not call cloud APIs.

Audience​

This documentation assumes that you already understand Alibaba Cloud product concepts such as regions, AccessKeys, VPCs, vSwitches, ECS instances, security groups, and ACK clusters. It also assumes you are comfortable using a CLI with local profiles.

ecctl can read its own configuration and compatible local aliyun CLI configuration files. This is configuration compatibility only; the two tools serve different command surfaces and can be used side by side.

What to Read​

Start with:

Then use:

  • Concepts for the Agent-first model: command contracts, synchronous execution, and structured output.
  • Command Model for product/resource/action grammar.
  • Schema for schema and capabilities.
  • Resource Operations for a full create/inspect/list/delete walkthrough with real output.
  • Output for JSON, text, language, and errors.
  • OpenAPI Calls when a resource command is not modeled yet.
  • Resource Coverage for the public resource list generated from the current schema.

Source of Truth​

The user-facing command contract is generated from resource specs and exposed by ecctl schema. When a page shows resource parameters, waiter behavior, aliases, or supported actions, it is based on local schema or --help output rather than hand-written assumptions.