DescribeCommands - 查詢已建立的雲助手命令 - Elastic Compute Service

查詢您手動建立的雲助手命令或者阿里雲提供的公用命令。

介面說明

只輸入參數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
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：返回 Base 64 編碼後的指令碼內容和輸出資訊。預設值為 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	自訂參數的Regex規則。	^[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	命令內容，以 Base 64 編碼後傳輸。若 ContentEncoding 指定 PlainText，返回原始指令碼內容。若 ContentEncoding 指定 Base64，返回 Base 64 編碼後的指令碼內容。	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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。