1つ以上のElastic Compute Service (ECS) インスタンスにファイルを送信します。

説明

  • ファイルの送信先のインスタンスは、実行中 (実行中) 状態である必要があります。
  • Cloud Assistantクライアントをインスタンスにインストールする必要があります。 Cloud Assistantクライアントのインストール方法については、「InstallCloudAssistant」をご参照ください。
  • 次のバージョンよりも後のバージョンのCloud Assistantクライアントのみがファイル送信をサポートしています。 ClientNeedUpgradeエラーコードが返された場合は、Cloud Assistantクライアントを最新バージョンにアップグレードする必要があります。 詳細については、「Cloud Assistantクライアントの更新または無効化」をご参照ください。
    • Linuxインスタンスの場合、Cloud Assistantクライアントのバージョンは1.0.2.569以降である必要があります。
    • Windowsインスタンスの場合、Cloud Assistantクライアントのバージョンは1.0.0.149以降である必要があります。
  • 送信されるファイルは、Base64でエンコードされた後、サイズが32 KBを超えてはなりません。
  • インスタンス、ネットワーク、またはCloud Assistanceクライアントの例外が原因で、ファイルの送信に失敗する場合があります。 DescribeSendFileResults操作を呼び出して、問題のトラブルシューティングを行います。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 SendFile

実行する操作です。 値をSendFileに設定します。

RegionId String 必須 cn-hangzhou

The region ID of the instance to which to send the file. DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

パラメーター名 String 必須 file.txt

ファイルの名前。 名前はすべての文字セットをサポートし、長さは最大255文字です。

説明 String 任意 これはテストファイルです。

ファイルの説明。 The description supports all character sets and can be up to 512 characters in length.

Timeout Long 任意 60

ファイルを送信するためのタイムアウト期間。 (単位：秒)

  • プロセスが遅くなったり、特定のモジュールまたはCloud Assistantクライアントが存在しないためにファイルを送信できない場合、タイムアウトエラーが発生します。
  • 指定されたタイムアウト期間が10秒未満の場合、システムは自動的にタイムアウト期間を10秒に設定し、ファイルがインスタンスに送信されるようにします。

デフォルト値: 60。

TargetDir String 必須 /ホーム

ファイルを送信するインスタンスの宛先ディレクトリ。 If the specified directory does not exist, the system creates the directory on the instance.

ContentType String 任意 PlainText

ファイルのコンテンツタイプ。 設定可能な値は以下のとおりです。

  • PlainText: コマンドの内容はエンコードされていません。
  • Base64: コマンドの内容がBase64-encodedです。

デフォルト値: PlainText。

Content String 必須 #!/bin/bash echo "Current User is :" echo $(ps grep "$$" awk '{print $2}') ------- oss:// bucketName/objectName

ファイルの内容。 コンテンツは、Base64でエンコードされた後、サイズが32 KBを超えてはなりません。

  • ContentTypeがPlainTextに設定されている場合、Content値はプレーンテキストになります。
  • If ContentType is set to Base64, the Content value is Base64-encoded.
FileOwner String 任意 root

ファイルの所有者。 このパラメーターは、Linuxインスタンスでのみ有効です。 デフォルト値：root。

FileGroup String 任意 root

ファイルのユーザーグループ。 このパラメーターは、Linuxインスタンスでのみ有効です。 デフォルト値：root。

FileMode String 任意 0644

ファイルに対する権限。 このパラメーターは、Linuxインスタンスでのみ有効です。 このパラメーターは、chmodコマンドの設定と同じ方法で設定できます。

デフォルト値: 0644。これは、ファイルの所有者がファイルに対する読み取りおよび書き込み権限を持ち、ファイルのユーザーグループおよび他のユーザーがファイルに対する読み取り権限のみを持つことを示します。

上書き Boolean 任意 true

送信されたファイルと同じ名前のファイルを宛先ディレクトリに上書きするかどうかを指定します。

  • true: ファイルを上書きします。
  • false: ファイルを上書きしません。

規定値: false

<td class="en-UStry align-left colsep-1 rowsep-1"> InstanceId.N </td> String 必須 i-bp185dy2o3o6n ****

ファイルを送信するインスタンスNのID。 最大50個のインスタンスIDを指定できます。 Nの有効値: 1 ~ 50。

レスポンスパラメーター

パラメーター データ型 例 説明
InvokeId String f-7d2a745b412b46 ****

実行のID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエストの ID です。

例

リクエストの例

https://ecs.aliyuncs.com/?Action=SendFile
&コンテンツ='echo hello'
&InstanceId.1=i-bp185dy2o3o6n ****
&Name=file.txt
&RegionId=cn-hangzhou
&TargetDir=/home
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<SendFileResponse>
        <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
        <InvokeId>f-7d2a745b412b46 ****</InvokeId>
</SendFileResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E69EF3CC-94CD-42E7-8926-F133B86387C0",
  "InvokeId" : "f-7d2a745b412b46 ****"
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 RegionId.ApiNotSupported このリージョンではapiはサポートされていません。 指定されたリージョンでAPI操作を呼び出すことができない場合に返されるエラーメッセージ。 RegionIdパラメーターが有効かどうかを確認します。
403 FileSize.ExceedLimit ファイルコンテンツの長さが制限を超えています。 ファイルコンテンツの最大長に達した場合に返されるエラーメッセージ。
403 FileName.ExceedLimit ファイル名の長さが制限を超えています。 ファイル名の最大長に達した場合に返されるエラーメッセージ。
403 FileDesc.ExceedLimit ファイルの説明の長さが制限を超えています。 ファイルの説明の最大長に達した場合に返されるエラーメッセージ。
403 FileTargetDir.Invalid ファイルの対象ディレクトリが不正です。 指定されたTargetDirパラメーターが無効な場合に返されるエラーメッセージ。
403 InstanceIds.ExceedLimit インスタンスIDの数が上限を超えています。 The error message returned because the maximum number of specified instance IDs has been reached.
403 FileMode.Invalid ファイルのモードが無効です。 指定されたFileModeパラメーターが無効な場合に返されるエラーメッセージ。
403 FileContent.DecodeError コンテンツはbase64デコードできません。 ファイルの内容がBase64でデコードできない場合に返されるエラーメッセージ。
403 FileContentType.Invalid ファイルのContentTypeが無効です。 指定されたContentTypeパラメーターが無効な場合に返されるエラーメッセージ。
403 操作禁止 操作は許可されていません。 操作がサポートされていない場合に返されるエラーメッセージ。
404 InvalidInstance.NotFound 指定されたインスタンスが見つかりません。 指定された InstanceId パラメーターが存在しない場合に返されるエラーメッセージ。
500 InternalError.Dispatch リクエストの送信時にエラーが発生しました。 リクエストの送信時にエラーが発生した場合に返されるエラーメッセージ。 しばらくしてから再試行します。

エラーコードリストについては、「API エラーセンター」をご参照ください。