DescribeCommands - 查询命令 - 轻量应用服务器

查询您手动创建的命令或者阿里云提供的公共命令。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
swas-open:DescribeCommands		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
CommandId	string	否	命令 ID。	c-sh02yh0932w****
Name	string	否	命令的名称，暂不支持模糊查询。	testName
Provider	string	是	公共命令的提供者。参数值的具体说明如下：当该参数取值为`AlibabaCloud`时，查询由阿里云提供的所有公共命令。当该参数的取值为`User`时，查询由您创建的所有自定义命令。	AlibabaCloud
Type	string	否	命令的语言类型。取值范围： RunBatScript：适用于 Windows 实例的 Bat 命令。 RunPowerShellScript：适用于 Windows 实例的 PowerShell 命令。 RunShellScript：适用于 Linux 实例 Shell 命令。	RunShellScript
PageNumber	string	否	当前页码。起始值：1。默认值：1。	1
PageSize	string	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10
Tag	array<object>	否	命令的标签列表。
	object	否	标签。
Key	string	否	命令的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。	TestKey
Value	string	否	命令的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。	TestValue
ResourceGroupId	string	否	资源组 ID。	rg-aek2bti7cf7****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	20758A-585D-4A41-A9B2-28DA8F4F****
TotalCount	integer	命令总条数。	10
PageNumber	integer	命令列表页码。	1
PageSize	integer	每页行数。	10
Commands	array<object>	命令列表。
	object	命令信息结构体。
CommandId	string	命令 ID。	c-gov1k1tqwi9****
Tags	array<object>	命令的标签列表。
	object	标签。
Key	string	命令的标签键。	TestKey
Value	string	命令的标签值。	TestValue
CreationTime	string	命令创建时间。	2023-01-05T06:38:53Z
Name	string	命令名称。	testName
Provider	string	命令的提供者。	User
Type	string	命令类型。	RunShellScript
Timeout	long	超时时间。	60
Description	string	命令描述。	testDescription
WorkingDir	string	执行路径。	/home
CommandContent	string	命令内容。	cat /etc/ssh/sshd_config
EnableParameter	boolean	该命令是否启用自定义参数。	false
ParameterNames	array	通过创建命令时的 CommandContent 解析出的自定义参数名列表，以列表（List）的形式返回。如未使用自定义参数功能，则返回空值列表。
	string	自定义参数。	parameter1
ParameterDefinitions	array<object>	自定义参数详细信息列表。
	object	自定义参数详细信息结构体。
Required	boolean	该自定义参数是否必填。 true：是。 false：否。默认值：false。	false
Description	string	自定义参数描述。	命令助手Agent安装包路径
DefaultValue	string	自定义参数的默认值。	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
ParameterName	string	自定义参数名称。	DownloadUrl
PossibleValues	array	枚举类型自定义参数的可选值。
	string	枚举类型自定义参数值。	Linux
ResourceGroupId	string	资源组 ID。	rg-aek2bti7cf7****

示例

正常返回示例

JSON格式

{
  "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": "命令助手Agent安装包路径",
          "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
          "ParameterName": "DownloadUrl",
          "PossibleValues": [
            "Linux"
          ]
        }
      ],
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-29	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-02-20	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情