通过DescribeCommands查询云助手命令-云服务器 ECS-阿里云-云服务器 ECS(ECS)-阿里云帮助中心

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

接口说明

只输入参数Action和RegionId，不输入其他任何请求参数，则默认查询您手动创建的所有可用的命令（CommandId）。
分页查询首页时，仅需设置MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribeCommands

get

Command

acs:ecs:{#regionId}:{#accountId}:command/*

Command

acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
Provider	string	否	公共命令的提供者。参数值的具体说明如下：当该参数不传值时，默认查询您手动创建的所有云助手命令。当该参数取值为`AlibabaCloud`时，查询由阿里云提供的所有公共命令。当该参数的取值为具体的公共命令提供者时，查询该提供者提供的所有公共命令。例如：当`Provider=AlibabaCloud.ECS.GuestOS`时，查询`AlibabaCloud.ECS.GuestOS`提供的公共命令。当`Provider=AlibabaCloud.ECS.GuestOSDiagnose`时，查询`AlibabaCloud.ECS.GuestOSDiagnose`提供的公共命令。	AlibabaCloud
CommandId	string	否	命令 ID。	c-hz01272yr52****
Name	string	否	命令的名称。当指定了`Provider`参数查询公共命令时，默认支持模糊查询。当未指定`Provider`参数查询私有命令时，支持模糊查询，例如输入`command`，可以搜索出所有名称以`command`开头的命令；输入`command`，可以搜索出所有名称以`command`结尾的命令；输入`command`，可以搜索出所有名称包含`command`的命令。	testName
Description	string	否	命令的描述。当指定了`Provider`参数查询公共命令时，默认支持模糊查询。当未指定`Provider`参数查询私有命令时，支持模糊查询，例如输入`test`，可以搜索出所有描述以`test`开头的命令；例如输入`test`，可以搜索出所有描述以`test`结尾的命令；例如输入`test`，可以搜索出所有描述包含`test`的命令。	testDescription
Type	string	否	命令的类型。取值范围： RunBatScript：命令为在 Windows 实例中运行的 Bat 脚本。 RunPowerShellScript：命令为在 Windows 实例中运行的 PowerShell 脚本。 RunShellScript：命令为在 Linux 实例中运行的 Shell 脚本。	RunShellScript
ContentEncoding	string	否	设置返回数据中`CommandContent`字段和`Output`字段的编码方式。取值范围： PlainText：返回原始脚本内容和输出信息。 Base64：返回 Base64 编码后的脚本内容和输出信息。默认值为 Base64。	PlainText
PageNumber	integer	否	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。	1
PageSize	integer	否	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。	10
MaxResults	integer	否	分页查询时每页的最大条目数。最大值为 50。默认值为 10。	10
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	AAAAAdDWBF2
Latest	boolean	否	若查询结果包含公共命令，是否只查询最新版本的公共命令。该参数不影响私有命令的查询。 true：只查询最新版本的公共命令。 false：查询所有版本的公共命令。默认值：false。	true
ResourceGroupId	string	否	命令所属的资源组 ID。	rg-123******
Tag	array<object>	否	标签列表。
	object	否	标签对象。
Value	string	否	命令的标签值。N 的取值范围为 1~20。该值可以为空字符串。最多支持 128 个字符，不能包含`http://`或`https://`。	TestValue
Key	string	否	命令的标签键。N 的取值范围为 1~20。一旦传入该值，则不允许为空字符串。使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，您需要使用 ListTagResources 接口进行查询。最多支持 64 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	TestKey

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页行数。	10
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	命令列表页码。	1
TotalCount	integer	命令总个数。	5
NextToken	string	本次调用返回的查询凭证值。	AAAAAdDWBF2
Commands	object
Command	array<object>	命令数据集。
	array<object>	命令对象。
ParameterDefinitions	object
ParameterDefinition	array<object>	自定义参数详细信息列表。
	array<object>	自定义参数对象。
DefaultValue	string	自定义参数的默认值。	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
Description	string	自定义参数描述。	云助手Agent安装包路径
Required	boolean	该自定义参数是否必填。 true：是。 false：否。默认值：false。	true
ParameterName	string	自定义参数名称。	DownloadUrl
PossibleValues	object
PossibleValue	array	枚举类型自定义参数的可选值列表。
	string	枚举类型自定义参数的可选值。	"Linux","Windows"
PatternRegex	string	自定义参数的正则表达式规则。	^[a-zA-Z0-9_-]{4,32}$
Description	string	命令描述。	testDescription
Category	string	公共命令的类目。	“”
ResourceGroupId	string	命令所属的资源组 ID。	rg-123******
ParameterNames	object
ParameterName	array	通过创建命令时的 commandcontent 解析出的自定义参数名列表，以列表（list）的形式返回。如未使用自定义参数功能，则返回空值列表。
	string	自定义参数名。	['parameter1','parameter2']
Timeout	integer	超时时间，单位：秒。	3600
Provider	string	公共命令的提供者。	AlibabaCloud.ECS.GuestOS
Name	string	命令名称。	testName
WorkingDir	string	执行路径。	/home/
CommandContent	string	命令内容，以 Base64 编码后传输。若 ContentEncoding 指定 PlainText，返回原始脚本内容。若 ContentEncoding 指定 Base64，返回 Base64 编码后的脚本内容。	Y2QgL3Jvb3Q=
Type	string	命令类型。	RunShellScript
Version	integer	公共命令的版本。如果多个命令属于同一个`Provider`，且名称与类目相同，则这些命令属于同一个命令的不同版本。您手动创建的云助手命令不会返回该值。	1
InvokeTimes	integer	使用该命令创建的任务数。	2
CreationTime	string	命令创建时间。	2020-11-17T06:52Z
Launcher	string	脚本执行的引导程序。长度不能超过 1 KB。	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}
Latest	boolean	公共命令是否是最新版本。如果多个命令属于同一个`Provider`，且名称与类目相同，则这些命令属于同一个命令的不同版本。您手动创建的云助手命令不会返回该值。	true
EnableParameter	boolean	该命令是否启用自定义参数。	true
CommandId	string	命令 ID。	c-hz01272yr52****
Tags	object
Tag	array<object>	命令的标签信息列表。
	object	命令的标签信息对象。
TagKey	string	命令的标签键。	owner
TagValue	string	命令的标签值。	zhangsan

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "TotalCount": 5,
  "NextToken": "AAAAAdDWBF2",
  "Commands": {
    "Command": [
      {
        "ParameterDefinitions": {
          "ParameterDefinition": [
            {
              "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
              "Description": "云助手Agent安装包路径",
              "Required": true,
              "ParameterName": "DownloadUrl",
              "PossibleValues": {
                "PossibleValue": [
                  "\"Linux\",\"Windows\""
                ]
              },
              "PatternRegex": "^[a-zA-Z0-9_-]{4,32}$\u0000"
            }
          ]
        },
        "Description": "testDescription",
        "Category": "“”",
        "ResourceGroupId": "rg-123******",
        "ParameterNames": {
          "ParameterName": [
            "['parameter1','parameter2']"
          ]
        },
        "Timeout": 3600,
        "Provider": "AlibabaCloud.ECS.GuestOS",
        "Name": "testName",
        "WorkingDir": "/home/",
        "CommandContent": "Y2QgL3Jvb3Q=",
        "Type": "RunShellScript",
        "Version": 1,
        "InvokeTimes": 2,
        "CreationTime": "2020-11-17T06:52Z",
        "Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}\n",
        "Latest": true,
        "EnableParameter": true,
        "CommandId": "c-hz01272yr52****",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "zhangsan"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
400	NumberExceed.Tags	The Tags parameter number is exceed.	标签个数超过最大限制。
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	标签中存在重复的键，请保持键的唯一性。
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	指定的标签键参数有误。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定的标签值参数有误。
400	MissingParameter.TagKey	You must specify Tag.N.Key.	请指定标签键。
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.	指定的参数NextToken不合法。
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	指定的参数MaxResults不合法。
500	InternalError.Dispatch	An error occurred when you dispatched the request.	发送请求时发生错误，请稍后重试。
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
500	InternalError	The request processing has failed due to some unknown error.
403	Operation.Forbidden	The operation is not permitted.	该操作是不被允许的。
403	InvalidName.LengthLimitExceeded	The length of the parameter Name exceeds the upper limit.
403	InvalidDescription.LengthLimitExceeded	The length of the parameter Description exceeds the upper limit.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	地域信息错误
404	InvalidCommandType.NotFound	The specified parameter Type does not exist.
404	InvalidCommandId.NotFound	The specified commandId does not exist

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

变更历史

更多信息，参考变更详情。