調用SendFile向一臺或多臺ECS實例下發遠程文件。
接口說明
- 目標 ECS 實例的狀態必須為運行中（
Running）。 - 目標 ECS 實例必須預先安裝云助手 Agent。
- 云助手 Agent 版本需要高于以下對應的版本才能支持下發文件。如果結果返回
ClientNeedUpgrade錯誤碼，請將客戶端更新至最新版本。- Linux：1.0.2.569
- Windows：1.0.0.149
- 文件內容在進行 Base64 編碼后，大小不能超過 32 KB。
- 文件下發可能會因為目標 ECS 實例的狀態異常、網絡異常或云助手 Agent 異常而出現失敗的情況。請調用 DescribeSendFileResults ，或參考執行失敗常見錯誤及修復建議進行問題排查。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:SendFile | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 目標 ECS 實例所在的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ResourceGroupId | string | 否 | 文件下發的資源組 ID，當指定該參數時：
| rg-bp67acfmxazb4p**** |
| Name | string | 是 | 文件名稱。支持全字符集，長度不得超過 255 個字符。 | file.txt |
| Description | string | 否 | 描述信息。支持全字符集，長度不得超過 512 個字符。 | This is a test file. |
| Timeout | long | 否 | 下發文件的超時時間。單位：秒。
默認值為 60。 | 60 |
| TargetDir | string | 是 | 文件下發目標 ECS 實例中的目錄。如不存在則會自動創建。長度不得超過 255 個字符。 | /home |
| ContentType | string | 否 | 文件內容類型。
默認值為 PlainText。 | PlainText |
| Content | string | 是 | 文件內容。文件內容在 Base64 編碼后，大小不能超過 32 KB。
| #!/bin/bash echo "Current User is :" echo $(ps | grep "$$" | awk '{print $2}') -------- oss://bucketName/objectName |
| FileOwner | string | 否 | 文件的用戶。只對 Linux 實例生效，默認為 root。長度不得超過 64 個字符。 說明
使用其他用戶時，請確保實例中存在該用戶。
| test |
| FileGroup | string | 否 | 文件的用戶組。只對 Linux 實例生效，默認為 root。長度不得超過 64 個字符。 說明
使用其他用戶組時，請確保實例中存在該用戶組。
| test |
| FileMode | string | 否 | 文件的權限。只對 Linux 實例生效，設置方式與 chmod 命令相同。 默認值為 0644，表示用戶具有讀寫權限，用戶組和其它用戶具有只讀權限。 | 0644 |
| Overwrite | boolean | 否 | 如果同名文件在目標目錄已存在，是否覆蓋文件。
默認值為 false。 | true |
| InstanceId | array | 是 | 需要執行命令的 ECS 實例列表。最多能指定 50 臺 ECS 實例 ID。N 的取值范圍為 1~50。 | |
| string | 是 | 需要執行命令的 ECS 實例列表。最多能指定 50 臺 ECS 實例 ID。N 的取值范圍為 1~50。 | i-bp185dy2o3o6n**** | |
| Tag | array<object> | 否 | 標簽列表。 | |
| object | 否 | 標簽列表。 | ||
| Key | string | 否 | 文件下發的標簽鍵。N 的取值范圍為 1~20。一旦傳入該值，則不允許為空字符串。 使用一個標簽過濾資源，查詢到該標簽下的資源數量不能超過 1000 個。使用多個標簽過濾資源，查詢到同時綁定了多個標簽的資源數量不能超過 1000 個。如果資源數量超過 1000 個，您需要使用 ListTagResources 接口進行查詢。 最多支持 64 個字符，不能以 | TestKey |
| Value | string | 否 | 文件下發的標簽值。N 的取值范圍為 1~20。該值可以為空字符串。 最多支持 128 個字符，不能包含 | TestValue |
返回參數
示例
正常返回示例
JSON格式
{
"InvokeId": "f-7d2a745b412b46****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持調用 API。請檢查 RegionId 參數取值是否正確。 |
| 400 | MissingParam.InstanceId | The parameter instanceId is missing or empty. | 實例ID為空。 |
| 400 | NumberExceed.Tags | The Tags parameter number is exceed. | 標簽個數超過最大限制。 |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | 請指定標簽鍵。 |
| 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 | FileTargetDir.Invalid | The target directory of file is invalid. | 目標路徑TargetDir參數無效。 |
| 400 | FileMode.Invalid | The mode of file is invalid. | 文件權限FileMode參數無效。 |
| 400 | FileContent.DecodeError | The Content can not be base64 decoded. | 文件內容Base64解碼錯誤。 |
| 400 | FileContentType.Invalid | The ContentType of file is invalid. | 文件內容類型ContentType參數無效。 |
| 400 | InvalidParameter.FileOwner | The specified parameter FileOwner is not valid. | 指定的參數FileOwner不合法。 |
| 400 | InvalidParameter.FileGroup | The specified parameter FileGroup is not valid. | 指定的參數FileGroup不合法。 |
| 403 | FileSize.ExceedLimit | The length of file content exceeds limit. | 文件內容長度超過上限。 |
| 403 | FileName.ExceedLimit | The length of file name exceeds limit. | 文件名稱長度超過上限。 |
| 403 | FileDesc.ExceedLimit | The length of file description exceeds limit. | 文件描述長度超過上限。 |
| 403 | InstanceIds.ExceedLimit | The number of instance IDs exceeds the upper limit. | 目標實例數量超過上限。 |
| 403 | Operation.Forbidden | The operation is not permitted. | 該操作是不被允許的。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
| 404 | InvalidInstance.NotFound | The specified instances not found. | 指定的實例ID不存在。 |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | 資源組并不在記錄中。 |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 發送請求時發生錯誤，請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-05 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-05-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-02-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |