查询您手动创建的云助手命令或者阿里云提供的公共命令。
调试
您可以在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 |
| CommandId | string | 否 | 命令 ID。 | c-hz01272yr52**** |
| Name | string | 否 | 命令的名称。
| testName |
| Description | string | 否 | 命令的描述。
| testDescription |
| Type | string | 否 | 命令的类型。取值范围：
| RunShellScript |
| ContentEncoding | string | 否 | 设置返回数据中
默认值为 Base64。 | PlainText |
| PageNumber | long | 否 | 说明
该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
| 1 |
| PageSize | long | 否 | 说明
该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
| 10 |
| MaxResults | integer | 否 | 分页查询时每页的最大条目数。 最大值为 50。 默认值为 10。 | 10 |
| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | AAAAAdDWBF2 |
| Latest | boolean | 否 | 若查询结果包含公共命令，是否只查询最新版本的公共命令。该参数不影响私有命令的查询。
默认值：false。 | true |
| ResourceGroupId | string | 否 | 命令所属的资源组 ID。 | rg-123****** |
| Tag | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签列表。 | ||
| Value | string | 否 | 命令的标签值。N 的取值范围为 1~20。该值可以为空字符串。 最多支持 128 个字符，不能包含 | TestValue |
| Key | string | 否 | 命令的标签键。N 的取值范围为 1~20。一旦传入该值，则不允许为空字符串。 使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，您需要使用 ListTagResources 接口进行查询。 最多支持 64 个字符，不能以 | TestKey |
返回参数
示例
正常返回示例
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. | 指定的 PageNumber 参数无效。 |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | 指定的 PageSize 参数无效。 |
| 400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | 指定的参数NextToken不合法。 |
| 400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 指定的参数MaxResults不合法。 |
| 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. | - |
| 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. | 内部错误，请重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-03-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-12-05 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-10-21 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-10-24 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-02-25 | OpenAPI 错误码发生变更 | 查看变更详情 |