查詢您手動創(chuàng)建的云助手命令或者阿里云提供的公共命令。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:DescribeCommands | get | *Command acs:ecs:{#regionId}:{#accountId}:command/**Command acs:ecs:{#regionId}:{#accountId}:command/{#commandId} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| Provider | string | 否 | 公共命令的提供者。參數(shù)值的具體說明如下：
| AlibabaCloud |
| CommandId | string | 否 | 命令 ID。 | c-hz01272yr52**** |
| Name | string | 否 | 命令的名稱。
| testName |
| Description | string | 否 | 命令的描述。
| testDescription |
| Type | string | 否 | 命令的類型。取值范圍：
| RunShellScript |
| ContentEncoding | string | 否 | 設(shè)置返回數(shù)據(jù)中
默認(rèn)值為 Base64。 | PlainText |
| PageNumber | long | 否 | 說明
該參數(shù)即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 1 |
| PageSize | long | 否 | 說明
該參數(shù)即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 10 |
| MaxResults | integer | 否 | 分頁查詢時每頁的最大條目數(shù)。 最大值為 50。 默認(rèn)值為 10。 | 10 |
| NextToken | string | 否 | 查詢憑證（Token），取值為上一次 API 調(diào)用返回的 NextToken 參數(shù)值。 | AAAAAdDWBF2 |
| Latest | boolean | 否 | 若查詢結(jié)果包含公共命令，是否只查詢最新版本的公共命令。該參數(shù)不影響私有命令的查詢。
默認(rèn)值：false。 | true |
| ResourceGroupId | string | 否 | 命令所屬的資源組 ID。 | rg-123****** |
| Tag | array<object> | 否 | 標(biāo)簽列表。 | |
| object | 否 | 標(biāo)簽列表。 | ||
| Key | string | 否 | 命令的標(biāo)簽鍵。N 的取值范圍為 1~20。一旦傳入該值，則不允許為空字符串。 使用一個標(biāo)簽過濾資源，查詢到該標(biāo)簽下的資源數(shù)量不能超過 1000 個；使用多個標(biāo)簽過濾資源，查詢到同時綁定了多個標(biāo)簽的資源數(shù)量不能超過 1000 個。如果資源數(shù)量超過 1000 個，您需要使用 ListTagResources 接口進(jìn)行查詢。 最多支持 64 個字符，不能以 | TestKey |
| Value | string | 否 | 命令的標(biāo)簽值。N 的取值范圍為 1~20。該值可以為空字符串。 最多支持 128 個字符，不能包含 | TestValue |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber": 1,
"TotalCount": 5,
"NextToken": "AAAAAdDWBF2",
"Commands": {
"Command": [
{
"CreationTime": "2020-11-17T06:52Z",
"Type": "RunShellScript",
"Timeout": 3600,
"InvokeTimes": 2,
"CommandId": "c-hz01272yr52****",
"WorkingDir": "/home/",
"Description": "testDescription",
"Version": 1,
"Provider": "AlibabaCloud.ECS.GuestOS",
"CommandContent": "Y2QgL3Jvb3Q=",
"Category": "“”",
"Latest": true,
"Name": "testName",
"EnableParameter": true,
"ResourceGroupId": "rg-123******",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}\n",
"ParameterNames": {
"ParameterName": [
"['parameter1','parameter2']"
]
},
"ParameterDefinitions": {
"ParameterDefinition": [
{
"Required": true,
"Description": "云助手Agent安裝包路徑",
"DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
"ParameterName": "DownloadUrl",
"PossibleValues": {
"PossibleValue": [
"\"Linux\",\"Windows\""
]
}
}
]
},
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
}
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持調(diào)用 API。請檢查 RegionId 參數(shù)取值是否正確。 |
| 400 | NumberExceed.Tags | The Tags parameter number is exceed. | 標(biāo)簽個數(shù)超過最大限制。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標(biāo)簽中存在重復(fù)的鍵，請保持鍵的唯一性。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標(biāo)簽鍵參數(shù)有誤。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標(biāo)簽值參數(shù)有誤。 |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | 請指定標(biāo)簽鍵。 |
| 400 | InvalidParam.PageNumber | The specified parameter is invalid. | 指定的 PageNumber 參數(shù)無效。 |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | 指定的 PageSize 參數(shù)無效。 |
| 400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | 指定的參數(shù)NextToken不合法。 |
| 400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 指定的參數(shù)MaxResults不合法。 |
| 403 | Operation.Forbidden | The operation is not permitted. | 該操作是不被允許的。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 發(fā)送請求時發(fā)生錯誤，請稍后重試。 |
| 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. | 內(nèi)部錯誤，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-12-05 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-10-21 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-12-21 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-10-24 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-05-12 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-02-25 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |