文档

DescribeCommands - 查询已创建的云助手命令

更新时间:

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

接口说明

  • 只输入参数ActionRegionId,不输入其他任何请求参数,则默认查询您手动创建的所有可用的命令(CommandId)。

  • 支持以下两种方式查看返回数据:

    • 方式一:分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。
    • 方式二:通过PageSize设置单页返回的条目数,再通过PageNumber设置页码。以上两种方式只能任选其中之一。如果设置了MaxResultsNextToken参数,则请求参数PageSizePageNumber将失效,且返回数据中的TotalCount无效。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeCommandsRead
  • Command
    acs:ecs:{#regionId}:{#accountId}:command/*
  • Command
    acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
Providerstring

公共命令的提供者。参数值的具体说明如下:

  • 当该参数不传值时,默认查询您手动创建的所有云助手命令。
  • 当该参数取值为AlibabaCloud时,查询由阿里云提供的所有公共命令。
  • 当该参数的取值为具体的公共命令提供者时,查询该提供者提供的所有公共命令。例如:
    • Provider=AlibabaCloud.ECS.GuestOS时,查询AlibabaCloud.ECS.GuestOS提供的公共命令。
    • Provider=AlibabaCloud.ECS.GuestOSDiagnose时,查询AlibabaCloud.ECS.GuestOSDiagnose提供的公共命令。
AlibabaCloud
CommandIdstring

命令 ID。

c-hz01272yr52****
Namestring

命令的名称。

  • 当指定了Provider参数查询公共命令时,默认支持模糊查询。

  • 当未指定Provider参数查询私有命令时,支持前缀匹配的模糊查询,例如输入command*,可以搜索出所有名称以command开头的命令。

testName
Descriptionstring

命令的描述。

  • 当指定了Provider参数查询公共命令时,默认支持模糊查询。

  • 当未指定Provider参数查询私有命令时,支持前缀匹配的模糊查询,例如输入test*,可以搜索出所有描述以test开头的命令。

testDescription
Typestring

命令的类型。取值范围:

  • RunBatScript:命令为在 Windows 实例中运行的 Bat 脚本。
  • RunPowerShellScript:命令为在 Windows 实例中运行的 PowerShell 脚本。
  • RunShellScript:命令为在 Linux 实例中运行的 Shell 脚本。
RunShellScript
ContentEncodingstring

设置返回数据中CommandContent字段和Output字段的编码方式。取值范围:

  • PlainText:返回原始脚本内容和输出信息。
  • Base64:返回 Base64 编码后的脚本内容和输出信息。

默认值为 Base64。

PlainText
PageNumberlong

当前页码。

起始值为 1。

默认值为 1。

1
PageSizelong

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

最大值为 50。

默认值为 10。

10
MaxResultsinteger

分页查询时每页的最大条目数。

最大值为 50。

默认值为 10。

10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

AAAAAdDWBF2
Latestboolean

若查询结果包含公共命令,是否只查询最新版本的公共命令。该参数不影响私有命令的查询。

  • true:只查询最新版本的公共命令。

  • false:查询所有版本的公共命令。

默认值:false。

true
ResourceGroupIdstring

命令所属的资源组 ID。

rg-123******
Tagobject []

标签列表。

Keystring

命令的标签键。N 的取值范围为 1~20。一旦传入该值,则不允许为空字符串。

使用一个标签过滤资源,查询到该标签下的资源数量不能超过 1000 个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个,您需要使用 ListTagResources 接口进行查询。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://https://

TestKey
Valuestring

命令的标签值。N 的取值范围为 1~20。该值可以为空字符串。

最多支持 128 个字符,不能包含http://https://

TestValue

返回参数

名称类型描述示例值
object
PageSizelong

每页行数。

10
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberlong

命令列表页码。

1
TotalCountlong

命令总个数。

5
NextTokenstring

本次调用返回的查询凭证值。

AAAAAdDWBF2
Commandsobject []

命令数据集类型。

CreationTimestring

命令创建时间。

2020-11-17T06:52Z
Typestring

命令类型。

RunShellScript
Timeoutlong

超时时间,单位:秒。

3600
InvokeTimesinteger

使用该命令创建的任务数。

2
CommandIdstring

命令 ID。

c-hz01272yr52****
WorkingDirstring

执行路径。

/home/
Descriptionstring

命令描述。

testDescription
Versioninteger

公共命令的版本。如果多个命令属于同一个Provider,且名称与类目相同,则这些命令属于同一个命令的不同版本。您手动创建的云助手命令不会返回该值。

1
Providerstring

公共命令的提供者。

AlibabaCloud.ECS.GuestOS
CommandContentstring

命令内容,以 Base64 编码后传输。

  • 若 ContentEncoding 指定 PlainText,返回原始脚本内容。

  • 若 ContentEncoding 指定 Base64,返回 Base64 编码后的脚本内容。

Y2QgL3Jvb3Q=
Categorystring

公共命令的类目。

“”
Latestboolean

公共命令是否是最新版本。如果多个命令属于同一个Provider,且名称与类目相同,则这些命令属于同一个命令的不同版本。您手动创建的云助手命令不会返回该值。

true
Namestring

命令名称。

testName
EnableParameterboolean

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

true
ResourceGroupIdstring

命令所属的资源组 ID。

rg-123******
ParameterNamesarray

通过创建命令时的 commandcontent 解析出的自定义参数名列表,以列表(list)的形式返回。如未使用自定义参数功能,则返回空值列表。

string

通过创建命令时的 CommandContent 解析出的自定义参数名列表,以列表(List)的形式返回。如未使用自定义参数功能,则返回空值列表。

['parameter1','parameter2']
ParameterDefinitionsobject []

自定义参数详细信息列表。

Requiredboolean

该自定义参数是否必填。

  • true:是。

  • false:否。

默认值:false。

true
Descriptionstring

自定义参数描述。

云助手Agent安装包路径
DefaultValuestring

自定义参数的默认值。

https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
ParameterNamestring

自定义参数名称。

DownloadUrl
PossibleValuesarray

枚举类型自定义参数的可选值。

string

枚举类型自定义参数的可选值。

"Linux","Windows"
Tagsobject []

命令的标签信息。

TagKeystring

命令的标签键。

owner
TagValuestring

命令的标签值。

zhangsan

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400RegionId.ApiNotSupportedThe api is not supported in this region.指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
400NumberExceed.TagsThe Tags parameter number is exceed.标签个数超过最大限制。
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键,请保持键的唯一性。
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.指定的标签键参数有误。
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.指定的标签值参数有误。
400MissingParameter.TagKeyYou must specify Tag.N.Key.请指定标签键。
400InvalidParam.PageNumberThe specified parameter is invalid.指定的 PageNumber 参数无效。
400InvalidParam.PageSizeThe specified parameter is invalid.指定的 PageSize 参数无效。
400InvalidParameter.NextTokenThe specified parameter NextToken is not valid.指定的参数NextToken不合法。
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.指定的参数MaxResults不合法。
403Operation.ForbiddenThe operation is not permitted.该操作是不被允许的。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.提供的RegionId不存在
500InternalError.DispatchAn error occurred when you dispatched the request.发送请求时发生错误,请稍后重试。
500ServiceUnavailableThe request has failed due to a temporary failure of the server.请求后端超时,请稍后重试。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。

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

变更历史

变更时间变更内容概要操作
2023-12-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:MaxResults
    新增入参:NextToken
出参OpenAPI 返回结构发生变更
2023-10-24OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
2023-05-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    删除错误码:404
    删除错误码:500
2022-02-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    错误码 404 变更
    删除错误码:400
    删除错误码:500
  • 本页导读 (1)