Elastic Compute Service
Elastic Compute Service
Document
- Documentation
Elastic Compute ServiceElastic Compute ServiceAPI ReferenceCloud assistantModifyCommand - Modifies custom commands
Copy page
Download PDFCloud assistant
ModifyCommand - Modifies custom commands
Copy pageDownload PDFModifyCommand - Modifies custom commands
Call the ModifyCommand operation to modify the content of the specified custom command.
Usage notes
- If a command is being executed, the command contents can also be modified. After modification, the command is executed based on the new content.
- You can configure custom parameters in the command using parameters in the ParameterDefinitions.N.xxx structure. The usage rules are as follows:
- Argument - N: indicates the serial number of the custom parameter. Valid range: 1-60.
- Separate multiple custom parameters with &.
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.
Action string required Sample value: ModifyCommand
The action that you want to perform. Value: ModifyCommand.
Version string required Sample value: 2020-04-01
The version of the API. Valid value: 2020-04-01.
CommandId string required Sample value: cmd-hz0127****
The custom command ID. You can call the DescribeCommands operation to query and obtain custom command IDs.
Name string Optional Sample value: UpdateAgent
The command name. The default value is empty, which indicates retaining the original name.
- Character length: 1–32.
- Special characters can be used.
Type string Optional Sample value: Shell
The command type. Supported values:
- Shell: Indicates that the script type is Shell.
- Python: Indicates that the script type is Python.
- Bat: Indicates creating a Bat script.
- PowerShell: Indicates creating a PowerShell script.
Description string Optional Sample value: This is a description.
The command description. The default value is empty, which indicates retaining the original description.
- Character length: 0–256.
- Special characters can be used.
EnableParameter boolean Optional Sample value: false
Indicates whether the created command enables the custom parameter feature. Value:
- false: Disables the custom parameter feature.
- true: Enables the custom parameter feature.
ContentEncoding string Optional Sample value: Base64
Specifies whether the command content is Base64 encoded. Value:
- Base64 (default): The command content is Base64 encoded.
- PlainText: The command content is not Base64 encoded.
ParameterDefinitions.N.Name string[] Optional Sample value: ParameterDefinitions.1.Name=dir
The parameter name, which needs to be defined in the script based on {{Param}}. Naming rules:
- A parameter name cannot exceed 64 bytes in length.
- Follow Shell variable naming conventions: Use combinations of lowercase letters, uppercase letters, digits, underscores, and hyphens. Cannot begin with a digit. No spaces are allowed in the middle, but underscores can be used.
ParameterDefinitions.N.Type string[] Optional Sample value: String
The parameter type. Value:
- String: Indicates that the custom parameter is of the String (string) type.
- Digit: Indicates that the custom parameter is of the Digit (number) type.
ParameterDefinitions.N.Required boolean[] Optional Sample value: ParameterDefinitions.1.Required=true
Indicates whether the parameter is required. Value:
- true: Required.
- false: Not required.
tip
When the custom parameters are required and the InvokeCommand operation is used to execute commands, custom parameter values must be passed in the Parameters parameter.
ParameterDefinitions.N.DefaultValue string[] Optional Sample value: ParameterDefinitions.1.DefaultValue=ecs
The default value of the custom parameter.
tip
Pass in the default value corresponding to the parameter type specified by the Type parameter.
ParameterDefinitions.N.MinLength integer[] Optional Sample value: ParameterDefinitions.1.MinLength=1
The minimum length of the custom parameter value (string).
- Value range of MinLength: 1~1000.
- When Type=String, the parameter is required, and when Required is set to true, the default value is 1.
- The parameter value cannot exceed the value of MaxLength.
ParameterDefinitions.N.MaxLength integer[] Optional Sample value: ParameterDefinitions.1.MaxLength=98
The maximum length of the custom parameter value (string).
- Value range of MaxLength: 1~1000.
- When Type=String, the parameter is required, and when Required is set to true, the default value is 1000.
- The parameter value needs to exceed the value of MinLength.
ParameterDefinitions.N.MinValue string[] Optional Sample value: ParameterDefinitions.1.MinValue=1
The minimum value (number) of the custom parameter.
- Value range of MinValue: -1000000~1000000.
- When Type=Digit, the parameter is required, and when Required is set to true, the default value is -1000000.
- The parameter value cannot exceed the value of MaxValue.
ParameterDefinitions.N.MaxValue string[] Optional Sample value: ParameterDefinitions.1.MaxValue=100
The maximum value (number) of the custom parameter.
- Value range of MaxValue: -1000000~1000000.
- When Type=Digit, the parameter is required, and when Required is set to true, the default value is 1000000.
- The parameter value cannot exceed the value of MinValue.
ParameterDefinitions.N.DecimalPrecision integer[] Optional Sample value: ParameterDefinitions.1.DecimalPrecision=4
The number of decimal places allowed for the custom parameter value (number).
- Value range of DecimalPrecision: 0~10.
- When Type=Digit, the parameter is required, and when Required is set to true, the default value is 0.
CommandContent string Optional Sample value: IyEvYmluL2Jhc2gKZWNobyAib3BlcmF0aW9uIHN1Y2Nlc3MhIg==
The content obtained after Base64-encoding the command content.
tip
- Provide the corresponding command content based on the ContentEncoding parameter.
- Before coding, make sure that the first line of the script specifies the script interpreter. Rules are as follows:
- Shell script: The first line needs to be #!/bin/bash.
- Python script: The first line needs to be #!/usr/bin/python.
- The size of the command content cannot exceed 16 KB.
- When EnableParameter=true, the command content supports custom parameters. Rules are as follows:
- Define the custom parameter and enclose it in {{}}.
- Spaces and line breaks before and after the parameter name within {{}} are ignored.
WorkingDir string Optional Sample value: /home
The directory in which the created command runs in the ECS instance.
tip
For Linux instances, the default path is /home.
Username string Optional Sample value: root
The user name when the command is executed.
tip
The default user of executing a command in a Linux instance is root.
Timeout integer Optional Sample value: 60
The maximum timeout duration for the created command running on the ECS instance. Unit: seconds.
- Value range: 30~86400.
- Default value: 60.
tip
A timeout occurs when the created command cannot be executed for some reason. When the command execution times out, the command process is then stopped forcibly.
Response parameters
Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.
CommandId string Sample value: cmd-hz0127****
The custom command ID.
Sample request
Sample response
Error codes
The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.
Last updated: 2026.06.18 17:48:26
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
