DescribeCommands - Simple Application Server - Alibaba Cloud Documentation Center

Queries the commands that you created or the common commands that Alibaba Cloud provides.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
CommandId	string	No	The command ID.	c-sh02yh0932w****
Name	string	No	The command name. Fuzzy match is not supported.	testName
Provider	string	Yes	The provider of the common command. Take note of the following items: If you set this parameter to `AlibabaCloud`, all the common commands provided by Alibaba Cloud are queried. If you set this parameter to `User`, all the custom commands created by you are queried.	AlibabaCloud
Type	string	No	The language type of the command. Valid values: RunBatScript: batch command, applicable to Windows instances RunPowerShellScript: PowerShell command, applicable to Windows instances RunShellScript: shell command, applicable to Linux instances	RunShellScript
PageNumber	string	No	The page number. Pages start from 1. Default value: 1.	1
PageSize	string	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
Tag	object []	No	The tags of the command.
Key	string	No	The key of tag N to be added to the command. Valid values of N: 1 to 20.	TestKey
Value	string	No	The value of tag N to be added to the command. Valid values of N: 1 to 20.	TestValue

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F****
TotalCount	integer	The total number of commands.	10
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Commands	object []	The commands.
CommandId	string	The command ID.	c-gov1k1tqwi9****
Tags	object []	The tags of the command.
Key	string	The key of tag N to be added to the command. Valid values of N: 1 to 20.	TestKey
Value	string	The value of tag N to be added to the command. Valid values of N: 1 to 20.	TestValue
CreationTime	string	The time when the command was created.	2023-01-05T06:38:53Z
Name	string	The name of the command.	testName
Provider	string	The provider of the command.	User
Type	string	The command type.	RunShellScript
Timeout	long	The timeout period.	60
Description	string	The command description.	testDescription
WorkingDir	string	The working directory of the command.	/home
CommandContent	string	The command content.	cat /etc/ssh/sshd_config
EnableParameter	boolean	Indicates whether the custom parameter feature was enabled for the command.	false
ParameterNames	array	The list of custom parameter names that are parsed from the command specified when the command was being created. If the custom parameter feature is not enabled, an empty list is returned.
	string	The custom parameter name.	parameter1
ParameterDefinitions	object []	The custom parameters.
Required	boolean	Indicates whether the custom parameter is required. Valid values: true false Default value: false.	false
Description	string	The description of the custom parameter.	Command Assistant Agent Installation Package Path
DefaultValue	string	The default value of the custom parameter.	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
ParameterName	string	The name of the custom parameter.	DownloadUrl
PossibleValues	array	The valid values of the custom parameter of the enumeration type.
	string	The valid value of the custom parameter of the enumeration type.	Linux

Examples

Sample success responses

JSONformat

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 10,
  "Commands": [
    {
      "CommandId": "c-gov1k1tqwi9****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "CreationTime": "2023-01-05T06:38:53Z",
      "Name": "testName",
      "Provider": "User",
      "Type": "RunShellScript",
      "Timeout": 60,
      "Description": "testDescription",
      "WorkingDir": "/home",
      "CommandContent": "cat /etc/ssh/sshd_config",
      "EnableParameter": false,
      "ParameterNames": [
        "parameter1"
      ],
      "ParameterDefinitions": [
        {
          "Required": false,
          "Description": "Command Assistant Agent Installation Package Path",
          "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
          "ParameterName": "DownloadUrl",
          "PossibleValues": [
            "Linux"
          ]
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-02-20

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Tag
Output Parameters	The response structure of the API has changed.