查詢您已經建立的雲助手命令。只輸入參數 Action 和 RegionId，不輸入其他任何請求參數，則預設查詢您所有可用的命令（CommandId）。

請求參數

名稱 類型 是否必需 描述
Action String 是 系統規定參數。取值：DescribeCommands
RegionId String 是 地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。
CommandId String 否 命令 ID。
Type String 否 命令的類型。取值範圍：
  • RunBatScript：命令為在 Windows 執行個體中啟動並執行 Bat 指令碼
  • RunPowerShellScript：命令為在 Windows 執行個體中啟動並執行 PowerShell 指令碼
  • RunShellScript：命令為在 Linux 執行個體中啟動並執行 Shell 指令碼
Name String 否 命令的名稱，暫不支援模糊查詢。
PageNumber Integer 否 當前頁碼，起始值：1

預設值：1
PageSize Integer 否 分頁查詢時設定的每頁行數，最大值：50

預設值：10

返回參數

名稱 類型 描述
TotalCount Integer 命令總個數
PageNumber Integer 命令列表頁碼
PageSize Integer 每頁行數
Commands Array 命令資料集類型（CommandSetType）
資料集類型 CommandSetType
名稱 類型 描述
Command Array 命令類型（CommandType）
命令類型 CommandType
名稱 類型 描述
CommandId String 命令 ID
Name String 命令名稱
Description String 命令描述
Type String 命令類型
CommandContent String 命令內容，以 Base 64 編碼後傳輸
WorkingDir String 執行路徑
TimeOut Integer 逾時時間

樣本

請求樣本 
https://ecs.aliyuncs.com/?Action=DescribeCommands
&RegionId=cn-hangzhou
&<公用請求參數>
正常返回樣本

XML 格式

<DescribeCommandsResponse>
    <TotalCount>5</TotalCount>
    <Commands>
        <Command>
                <Name>Test</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>ZWNobyAxMjM=</CommandContent>
                <Timeout>3600</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-7d2a745b412b4601b2d47f6a768d3a14</CommandId>
                <Description>test</Description>
        </Command>
        <Command>
                <Name>Test1</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>Y2QgL3Jvb3Q=</CommandContent>
                <Timeout>3600</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-7d2a745b412b4601b2d47f6a768d3a15</CommandId>
                <Description>test1</Description>
        </Command>
        <Command>
                <Name>Test2</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>eXVtIHVwZGF0ZQ==</CommandContent>
                <Timeout>3600</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-7d2a745b412b4601b2d47f6a768d3a16</CommandId>
                <Description>test2</Description>
        </Command>
        <Command>
                <Name>Test3</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>c2VydmljZSBuZ2lueCByZWxvYWQ=</CommandContent>
                <Timeout>3600</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-7d2a745b412b4601b2d47f6a768d3a17</CommandId>
                <Description>test3</Description>
        </Command>
        <Command>
                <Name>Test4</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>bHM=</CommandContent>
                <Timeout>120</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-7d2a745b412b4601b2d47f6a768d3a18</CommandId>
                <Description>test4</Description>
        </Command>
    <PageNumber>1</PageNumber>
    <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
    <PageSize>10</PageSize>
</DescribeCommandsResponse>
JSON 格式 
{
    "TotalCount": 5,
    "Commands": {
        "Command": [
            {
                "Name": "Test",
                "WorkingDir": "",
                "CommandContent": "ZWNobyAxMjM=",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-7d2a745b412b4601b2d47f6a768d3a14",
                "Description": "test"
            },
            {
                "Name": "Test1",
                "WorkingDir": "",
                "CommandContent": "Y2QgL3Jvb3Q=",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-7d2a745b412b4601b2d47f6a768d3a15",
                "Description": "test1"
            },
            {
                "Name": "Test2",
                "WorkingDir": "",
                "CommandContent": "eXVtIHVwZGF0ZQ==",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-7d2a745b412b4601b2d47f6a768d3a16",
                "Description": "test2"
            },
            {
                "Name": "Test3",
                "WorkingDir": "",
                "CommandContent": "c2VydmljZSBuZ2lueCByZWxvYWQ=",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-7d2a745b412b4601b2d47f6a768d3a17",
                "Description": "test3"
            },
            {
                "Name": "Test4",
                "WorkingDir": "",
                "CommandContent": "bHM=",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-7d2a745b412b4601b2d47f6a768d3a18",
                "Description": "test4"
            },
        ]
    },
    "PageNumber": 1,
    "RequestId": "E69EF3CC-94CD-42E7-8926-F133B86387C0",
    "PageSize": 10
}
異常返回樣本

XML 格式

<Error>
    <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
    <HostId>ecs.aliyuncs.com</HostId>
    <Code>MissingParameter.RegionId</Code>
    <Message>The input parameter “RegionId” that is mandatory for processing this request is not supplied.</Message>
</Error>
JSON 格式 
{
    "RequestId": "E69EF3CC-94CD-42E7-8926-F133B86387C0",
    "HostId": "ecs.aliyuncs.com"
    "Code": "MissingParameter.RegionId"
    "Message": "The input parameter “RegionId” that is mandatory for processing this request is not supplied."
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼，請訪問 API 錯誤中心。

錯誤碼 錯誤資訊 HTTP 狀態代碼 說明
MissingParameter.RegionId The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 您必須指定必需參數 RegionId，或者您暫時不能使用指定 RegionId 裡的資源。
InvalidParam.pageNumber The specified parameter is invalid. 403 指定的頁碼不合法。
InvalidParam.PageSize The specified parameter is invalid. 403 指定的頁面大小不合法。
InvalidRegionId.NotFound The RegionId provided does not exist in our items. 404 指定的參數 RegionId不存在。
InternalError.Dispatch An internal error occurred when dispath the request 500 內部錯誤，請稍後嘗試。