Skip to main content

ecs assistant

Manage Cloud Assistant service settings and agent installation

Run ecctl ecs assistant <action> -h for usage, or ecctl schema ecs.assistant.<action> --full for the complete, agent-readable spec of every parameter and behavior.

update

ecctl ecs assistant update [flags]

Update Cloud Assistant service settings

  • Kind: mutation · Risk: medium
APIWhen calledPurpose
ModifyCloudAssistantSettingsEvery time the command runs.Perform the resource operation.
DescribeCloudAssistantSettingsWhen --no-wait is not specified.Read the resource view.
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--setting-typestringCloud Assistant setting type to update

get

ecctl ecs assistant get [flags]

Get Cloud Assistant service settings

  • Kind: read · Risk: low
APIWhen calledPurpose
DescribeCloudAssistantSettingsEvery time the command runs.Read the resource view.
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--fieldsstringcomma-separated resource fields to include
--setting-typesarrayCloud Assistant setting types to query (DescribeCloudAssistantSettings requires at least one) (default: ["InvocationDelivery","SessionManagerDelivery","AgentUpgradeConfig","SessionManagerConfig"])

install

ecctl ecs assistant install [flags]

Install the Cloud Assistant agent on instances

  • Kind: mutation · Risk: medium
  • Synchronous: waits for true (waiter assistant_available, timeout 300s); use --no-wait to skip.
APIWhen calledPurpose
InstallCloudAssistantEvery time the command runs.Perform the resource operation.
DescribeCloudAssistantStatusWhen --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
DescribeCloudAssistantStatusWhen --no-wait is not specified.Read the resource view.
ParameterTypeRequiredDescription
--instance-idsarrayinstance IDs to install the Cloud Assistant agent on
--regionstringAlibaba Cloud region