查詢您手動創建的命令或者阿里云提供的公共命令。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| swas-open:DescribeCommands | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| CommandId | string | 否 | 命令 ID。 | c-sh02yh0932w**** |
| Name | string | 否 | 命令的名稱，暫不支持模糊查詢。 | testName |
| Provider | string | 是 | 公共命令的提供者。參數值的具體說明如下：
| AlibabaCloud |
| Type | string | 否 | 命令的語言類型。取值范圍：
| 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**** |
返回參數
示例
正常返回示例
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****"
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-05-29 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-02-20 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |