调用DescribeCommands接口，查询命令列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeCommands

要执行的操作，取值：DescribeCommands。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

TagFilters.N.Key string[] 可选示例值：TagFilters.1.Key=k1

根据标签查询资源时指定的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。

不允许重复。

ProjectName string 可选示例值：default

所属项目，一个资源只能归属于一个项目。

Provider string 可选示例值：Volcengine

查询不同命令类型的所有命令。取值：

Volcengine：查询火山引擎提供的所有公共命令。

不传值时，默认查询用户手动创建的所有自定义命令。

CommandId string 可选示例值：cmd-hz012yr52****

命令ID。

Name string 可选示例值：updateAgent

命令名称。

Type string 可选示例值：Shell

命令类型。取值：

Shell：查询Shell类型的命令。

Python：查询Python类型的命令。

ContentEncoding string 可选示例值：Base64

指定返回的命令内容是否经过Base64编码处理。取值：

PlainText：未进行编码处理。

Base64：经过Base64编码处理。

Order string 可选示例值：created_at

返回命令的排序方式。取值：

created_at：按创建时间倒序排列。

name：按名称列的字母顺序进行排序。

说明

公共命令：默认按照name进行排序。

自定义命令：默认按照created_at排序，可以选择基于名称列（字母顺序）或创建时间列进行排序。

PageNumber integer 可选示例值：1

当前页码。

起始值：1。

默认值：1。

PageSize integer 可选示例值：10

分页查询时设置的每页行数。

取值范围：1~100。

默认值：10。

TagFilters.N.Values.N string[] 可选示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

根据标签查询资源时指定的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。

多个标签值之间用&分隔。

说明

如果传入该参数，则必须先传入TagFilters.N.Key。

不传则表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

PageSize integer 示例值：1

每页展示命令数。

PageNumber integer 示例值：10

命令列表页码。

TotalCount integer 示例值：4

命令总个数。

Commands object[] 示例值：--

符合条件的命令信息。

Name string 示例值：安装云监控Agent

命令名称。

CreatedAt string 示例值：2023-06-07T06:58:05Z

创建时间。

UpdatedAt string 示例值：2023-06-07T06:58:05Z

更新时间。

Type string 示例值：Shell

命令类型。

Timeout integer 示例值：60

超时时间。

WorkingDir string 示例值：/home

命令执行路径。

Username string 示例值：root

命令执行用户。

Description string 示例值：这是一个命令描述。

命令描述。

Provider string 示例值：Volcengine

公共命令的提供者。取值：Volcengine。

说明

Volcengine：由火山引擎提供。

查询自定义命令时，该返回值为空。

EnableParameter boolean 示例值：false

该命令是否启用自定义参数。取值：

false：未启用。

true：已启用。

ParameterDefinitions object[] 示例值：--

自定义参数详细信息列表(JSON格式)。

Name string 示例值：Param

自定义参数名称。

Type string 示例值：String

自定义参数类型。取值：

String：表示自定义参数类型为String（字符串）类型。

Digit：表示自定义参数类型为Digit（数值）类型。

Required boolean 示例值：true

参数是否必填。取值：

true：必填。

false：非必填。

DefaultValue string 示例值：DefaultValue

自定义参数默认值。

MinLength integer 示例值：1

自定义参数值（字符串）的最小长度。

MaxLength integer 示例值：50

自定义参数值（字符串）的最大长度。

MinValue string 示例值：10

自定义参数值（数值）的最小值。

MaxValue string 示例值：100

自定义参数值（数值）的最大值。

DecimalPrecision integer 示例值：2

自定义参数值（数值）允许的小数点后位数。

InvocationTimes integer 示例值：10

命令被调用次数。

说明

公共命令不显示调用次数。

ProjectName string 示例值：default

所属项目。

Tags object[] 示例值：--

标签。

Key string 示例值：Key1

标签名称。

Value string 示例值：Value1

标签值。

CommandId string 示例值：cmd-hz012yr52****

命令ID。

CommandContent string 示例值：IyEvYmluL2Jhc2****c3N3b3JkfX0iIHwgY2hwYXNzd2Q=

命令base64+URL编码后的内容。

说明

根据请求参数中ContentEncoding参数值，返回相应编码方式的命令内容。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.AccountId	The required parameter AccountId is not supplied.	用户ID不能为空。
400	InvalidType.Malformed	The specified Type is malformed.	指定的命令类型不合法。
400	InvalidOrder.Malformed	The specified Order is malformed.	指定的排序方式不合法。
400	LimitExceeded.TagFilterKeys	You've reached the limit on the number of TagFilter Keys that you can set.	已达到标签过滤键的数量上限。
400	MissingParameter.TagKey	The required parameter TagFiltersKey is not supplied.	标签过滤键不能为空。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的标签键不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的标签值不合法。
409	InvalidTagFilterKey.Conflict	The specified TagFilterKey already exists.	指定的标签过滤键已存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

云服务器