使用DescribeCommands擷取公用與自訂命令列表-Simple Application Server-阿里雲

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

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

swas-open:DescribeCommands

get

*Command

acs:swas-open:{#regionId}:{#accountId}:command/*

*Command

acs:swas-open:{#regionId}:{#accountId}:command/{#CommandId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。	cn-hangzhou
CommandId	string	否	命令 ID。	c-sh02yh0932w****
Name	string	否	命令的名稱，暫不支援模糊查詢。	testName
Provider	string	是	公用命令的提供者。參數值的具體說明如下：當該參數取值為`AlibabaCloud`時，查詢由阿里雲提供的所有公用命令。當該參數的取值為`User`時，查詢由您建立的所有自訂命令。	AlibabaCloud
Type	string	否	命令的語言類型。取值範圍： RunBatScript：適用於 Windows 執行個體的 Bat 命令。 RunPowerShellScript：適用於 Windows 執行個體的 PowerShell 命令。 RunShellScript：適用於 Linux 執行個體 Shell 命令。	RunShellScript
PageNumber	string	否	當前頁碼。起始值：1。預設值：1。	1
PageSize	string	否	分頁查詢時設定的每頁行數。最大值：50。預設值：10。	10
Tag	array<object>	否	命令的標籤列表。
	object	否	標籤。
Key	string	否	命令的標籤鍵。標籤鍵長度的取值範圍：1~64。N 的取值範圍：1~20。	TestKey
Value	string	否	命令的標籤值。標籤值長度的取值範圍：1~64。N 的取值範圍：1~20。	TestValue
ResourceGroupId	string	否	資源群組 ID。	rg-aek2bti7cf7****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	20758A-585D-4A41-A9B2-28DA8F4F****
TotalCount	integer	命令總條數。	10
PageNumber	integer	命令列表頁碼。	1
PageSize	integer	每頁行數。	10
Commands	array<object>	命令列表。
	array<object>	命令資訊結構體。
CommandId	string	命令 ID。	c-gov1k1tqwi9****
Tags	array<object>	命令的標籤列表。
	object	標籤。
Key	string	命令的標籤鍵。	TestKey
Value	string	命令的標籤值。	TestValue
CreationTime	string	命令建立時間。	2023-01-05T06:38:53Z
Name	string	命令名稱。	testName
Provider	string	命令的提供者。	User
Type	string	命令類型。	RunShellScript
Timeout	integer	逾時時間。	60
Description	string	命令描述。	testDescription
WorkingDir	string	執行路徑。	/home
CommandContent	string	命令內容。	cat /etc/ssh/sshd_config
EnableParameter	boolean	該命令是否啟用自訂參數。	false
ParameterNames	array	通過建立命令時的 CommandContent 解析出的自訂參數名列表，以列表（List）的形式返回。如未使用自訂參數功能，則返回空值列表。
	string	自訂參數。	parameter1
ParameterDefinitions	array<object>	自訂參數詳細資料列表。
	object	自訂參數詳細資料結構體。
Required	boolean	該自訂參數是否必填。 true：是。 false：否。預設值：false。	false
Description	string	自訂參數描述。	命令助手Agent安裝包路徑
DefaultValue	string	自訂參數的預設值。	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
ParameterName	string	自訂參數名稱。	DownloadUrl
PossibleValues	array	枚舉類型自訂參數的可選值。
	string	枚舉類型自訂參數值。	Linux
ResourceGroupId	string	資源群組 ID。	rg-aek2bti7cf7****

樣本

正常返回樣本

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"
          ]
        }
      ],
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

錯誤碼

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

變更歷史

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