文档

DescribeCommands - 查询命令

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

地域 ID。

cn-hangzhou
CommandIdstring

命令 ID。

c-sh02yh0932w****
Namestring

命令的名称,暂不支持模糊查询。

testName
Providerstring

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

  • 当该参数取值为AlibabaCloud时,查询由阿里云提供的所有公共命令。
  • 当该参数的取值为User时,查询由您创建的所有自定义命令。
AlibabaCloud
Typestring

命令的语言类型。取值范围:

  • RunBatScript:适用于 Windows 实例的 Bat 命令。
  • RunPowerShellScript:适用于 Windows 实例的 PowerShell 命令。
  • RunShellScript:适用于 Linux 实例 Shell 命令。
RunShellScript
PageNumberstring

当前页码。

起始值:1。

默认值:1。

1
PageSizestring

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

最大值:50。

默认值:10。

10
Tagobject []

命令的标签列表。

Keystring

命令的标签键。标签键长度的取值范围:1~64。N 的取值范围:1~20。

TestKey
Valuestring

命令的标签值。标签值长度的取值范围:1~64。N 的取值范围:1~20。

TestValue

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4F****
TotalCountinteger

命令总条数。

10
PageNumberinteger

命令列表页码。

1
PageSizeinteger

每页行数。

10
Commandsobject []

命令列表。

CommandIdstring

命令 ID。

c-gov1k1tqwi9****
Tagsobject []

命令的标签列表。

Keystring

命令的标签键。

TestKey
Valuestring

命令的标签值。

TestValue
CreationTimestring

命令创建时间。

2023-01-05T06:38:53Z
Namestring

命令名称。

testName
Providerstring

命令的提供者。

User
Typestring

命令类型。

RunShellScript
Timeoutlong

超时时间。

60
Descriptionstring

命令描述。

testDescription
WorkingDirstring

执行路径。

/home
CommandContentstring

命令内容。

cat /etc/ssh/sshd_config
EnableParameterboolean

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

false
ParameterNamesarray

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

string

自定义参数。

parameter1
ParameterDefinitionsobject []

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

Requiredboolean

该自定义参数是否必填。

  • true:是。

  • false:否。

默认值:false。

false
Descriptionstring

自定义参数描述。

命令助手Agent安装包路径
DefaultValuestring

自定义参数的默认值。

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

自定义参数名称。

DownloadUrl
PossibleValuesarray

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

string

枚举类型自定义参数值。

Linux

示例

正常返回示例

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 10,
  "Commands": [
    {
      "CommandId": "c-gov1k1tqwi9****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "CreationTime": "2023-01-05T06:38:53Z",
      "Name": "testName",
      "Provider": "User",
      "Type": "RunShellScript",
      "Timeout": 60,
      "Description": "testDescription",
      "WorkingDir": "/home",
      "CommandContent": "cat /etc/ssh/sshd_config",
      "EnableParameter": false,
      "ParameterNames": [
        "parameter1"
      ],
      "ParameterDefinitions": [
        {
          "Required": false,
          "Description": "命令助手Agent安装包路径",
          "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
          "ParameterName": "DownloadUrl",
          "PossibleValues": [
            "Linux"
          ]
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-02-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈