DescribeCommands--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeCommands

最近更新时间：2024.06.13 14:26:06首次发布时间：2023.09.04 15:43:18

调用DescribeCommands接口，查询批量作业命令列表。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeCommands	要执行的操作，取值：DescribeCommands。
Version	String	是	2020-04-01	接口的版本，取值：2020-04-01。
Provider	String	否	Volcengine	查询不同命令类型的所有命令。取值： Volcengine：查询火山引擎提供的所有公共命令。不传值时，默认查询用户手动创建的所有自定义命令。
CommandId	String	否	cmd-hz012yr52****	命令ID。
ContentEncoding	String	否	Base64	指定返回的命令内容是否经过Base64编码处理。取值： PlainText：未进行编码处理。 Base64：经过Base64编码处理。
Name	String	否	updateAgent	命令名称。
Type	String	否	Shell	命令类型。取值： Shell：查询Shell类型的命令。 Python：查询Python类型的命令。
Order	String	否	created_at	返回命令的排序方式。取值： created_at：按创建时间倒序排列。 name：按名称列的字母顺序进行排序。说明公共命令：默认按照`name`进行排序。自定义命令：默认按照`created_at`排序，可以选择基于名称列（字母顺序）或创建时间列进行排序。
OrderAscending	Boolean	否	false	指定返回命令按升序或降序排列。取值： false（默认）：降序 true：升序
PageNumber	Integer	否	1	当前页码。起始值：1。默认值：1。
PageSize	Integer	否	10	分页查询时设置的每页行数。取值范围：1~100。默认值：10。

返回数据

名称	类型	示例值	描述
PageSize	Integer	1	每页展示命令数。
PageNumber	Integer	10	命令列表页码。
TotalCount	Integer	4	命令总个数。
Commands	Array of Struct	-	符合条件的命令信息。具体请参见下表“Command 结构”。

Command 结构

名称	类型	示例值	描述
Name	String	安装云监控Agent	命令名称。
CommandId	String	cmd-hz012yr52****	命令ID。
CreateAt	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：由火山引擎提供。说明查询自定义命令时，该返回值为空。
CommandContent	String	IyEvYmluL2Jhc2******c3N3b3JkfX0iIHwgY2hwYXNzd2Q=	命令内容。说明根据请求参数中`ContentEncoding`参数值，返回相应编码方式的命令内容。
EnableParameter	Boolean	false	该命令是否启用自定义参数。取值： false：未启用。 true：已启用。
ParameterDefinitions	Array of Struct	-	自定义参数详细信息列表，具体请参见下表“ParameterDefinition 结构”。
InvocationTimes	Integer	10	命令被调用次数。

ParameterDefinition 结构

名称	类型	示例值	描述
Name	String	Param	参数名称。
Type	String	String	参数类型。取值： String：表示自定义参数类型为`String`（字符串）类型。 Digit：表示自定义参数类型为`Digit`（数值）类型。
Required	String	true	是否必填。取值： true：必填。 false：非必填。
DefaultValue	String	-	自定义参数默认值。
MinLength	Integer	1	自定义参数值（字符串）的最小长度。
MaxLength	Integer	50	自定义参数值（字符串）的最大长度。
MinValue	Integer	10	自定义参数值（数值）的最小值。
MaxValue	Integer	100	自定义参数值（数值）的最大值。
DecimalPrecision	Integer	2	自定义参数值（数值）允许的小数点后位数。

请求示例

GET /?Action=DescribeCommands&Version=2020-04-01&CommandId=cmd-4302d02424c5c8e10281e3a31**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeCommands",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Commands": [
           {
                "Name": "修改Linux实例密码",
                "CommandId": "cmd-yc1eagyk****",
                "CreateAt": "2022-11-07T08:33:38Z",
                "UpdatedAt": "2022-11-07T08:33:38Z",
                "Type": "Shell",
                "Timeout": 60,
                "WorkingDir": "/home",
                "Username": "root",
                "Description": "脚本描述",
                "Provider": "",
                "CommandContent": "IyEvYmluL2Jhc2******c3N3b3JkfX0iIHwgY2hwYXNzd2Q=",
                "EnableParameter": true,
                "ParameterDefinitions": [
                    {
                        "Type": "String",
                        "Name": "username",
                        "Required": true,
                        "DefaultValue": "",
                        "MinLength": 1,
                        "MaxLength": 100,
                        "MinValue": "",
                        "MaxValue": "",
                        "DecimalPrecision": 0
                    },
                    {
                        "Type": "String",
                        "Name": "password",
                        "Required": true,
                        "DefaultValue": "",
                        "MinLength": 1,
                        "MaxLength": 100,
                        "MinValue": "",
                        "MaxValue": "",
                        "DecimalPrecision": 0
                    }
                ],
                "InvocationTimes": 10
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。