すべてのプロダクト
Search

このプロダクト

    Platform For AI:DescribeSendFileResults

    ドキュメントセンター

    Platform For AI:DescribeSendFileResults

    最終更新日:Dec 21, 2025

    O&M アシスタントによって送信されたファイルとそのステータスを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    eflo:DescribeSendFileResults

    get

    *Node

    acs:eflo:{#regionId}:{#accountId}:node/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InvokeId

    string

    必須

    コマンド実行 ID。

    t-bj038i0d6r8zoqo
    NodeId

    string

    任意

    ノード ID。

    e01-cn-zvp2tgykr08

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    4FD06DF0-9167-5C6F-A145-F30CA4A15D54
    TotalCount

    string

    コマンドの総数。

    1
    Invocations

    object

    ファイル送信レコード。

    Invocation

    array<object>

    コマンド実行 ID。

    array<object>

    FileMode

    string

    ファイルの権限。

    0644
    Overwrite

    boolean

    送信されたファイルと同じ名前のファイルが宛先ディレクトリに存在する場合に、そのファイルが上書きされたかどうかを示します。

    • true

    • false

    デフォルト値：false。

    true
    InvocationStatus

    string

    ファイルの全体的な送信ステータス。ファイルの全体的な送信ステータスは、すべての宛先インスタンスでのファイルの送信ステータスに基づいて変動します。有効な値は次のとおりです：

    • Pending：ファイルは検証中または送信中です。少なくとも 1 つのインスタンスでファイルの送信状態が Pending の場合、ファイルの全体的な送信ステータスは Pending になります。

    • Running：ファイルはインスタンスに送信中です。少なくとも 1 つのインスタンスでファイルの送信状態が Running の場合、ファイルの全体的な送信ステータスは Running になります。

    • Success：すべてのインスタンスでファイルの送信状態が Success の場合、ファイルの全体的な送信ステータスは Success になります。

    • Failed：すべてのインスタンスでファイルの送信状態が Failed の場合、ファイルの全体的な送信ステータスは Failed になります。1 つ以上のインスタンスでファイルの送信状態が次のいずれかの値である場合、ファイルの全体的な送信ステータスは Failed になります：

      • Invalid：ファイルが無効です。

      • Aborted：インスタンスへのファイルの送信に失敗しました。

      • Failed：インスタンス上でのファイルの作成に失敗しました。

      • Timeout：ファイル送信タスクがタイムアウトしました。

      • Error：エラーが発生し、ファイル送信タスクが中断されました。

    • PartialFailed：一部のインスタンスではファイル送信タスクが完了しましたが、他のインスタンスでは失敗しました。一部のインスタンスで送信状態が Success で、他のインスタンスで Failed の場合、ファイルの全体的な送信ステータスは PartialFailed になります。

    Pending
    Description

    string

    コマンドの説明。

    Description

    ContentType

    string

    ファイルの内容タイプ。

    PlainText：ファイルの内容はエンコードされていません。Base64：ファイルの内容は Base64 でエンコードされています。デフォルト値：PlainText。

    PlainText
    NodeCount

    integer

    ノード数。

    3
    TargetDir

    string

    宛先ディレクトリ。

    /home/user
    FileGroup

    string

    ファイルのユーザーグループ。

    root
    FileOwner

    string

    ファイルのオーナー。

    root
    Name

    string

    ファイル送信タスクの名前。

    test
    Content

    string

    コマンドの出力。

    リクエストで ContentEncoding が PlainText に設定されている場合、元のコマンド出力が返されます。リクエストで ContentEncoding が Base64 に設定されている場合、Base64 でエンコードされたコマンド出力が返されます。

    Base64
    CreationTime

    string

    ファイル送信タスクが作成された時刻。

    2023-04-10T10:53:46.156+08:00

    InvokeNodes

    object

    ファイル送信レコード。

    InvokeNode

    array<object>

    ノード上のファイル送信レコード。

    object

    InvocationStatus

    string

    インスタンスでのファイル送信タスクのステータス。有効な値は次のとおりです：

    • Pending：ファイルは検証中または送信中です。

    • Invalid：ファイルが無効です。

    • Running：ファイルはインスタンスに送信中です。

    • Aborted：インスタンスへのファイルの送信に失敗しました。

    • Success：ファイルは送信されました。

    • Failed：インスタンス上でのファイルの作成に失敗しました。

    • Error：エラーが発生し、ファイル送信タスクが中断されました。

    • Timeout：ファイル送信タスクがタイムアウトしました。

    Success
    FinishTime

    string

    ファイル送信タスクが終了した時刻。時刻のフォーマットは `2020-05-22T17:04:18` です。

    2023-04-10T10:53:46.156+08:00
    NodeId

    string

    ノード ID。

    e01-cn-9lb3c15m81j
    ErrorInfo

    string

    コマンドの送信または実行に失敗した場合に返されるエラーメッセージ。有効な値は次のとおりです：

    • null：コマンドは正常に実行されました。

    • the specified instance does not exists：指定されたインスタンスが存在しないか、リリースされています。

    • the node has released when create task：コマンドの実行中にインスタンスがリリースされました。

    • the node is not running when create task：コマンドの実行中にインスタンスが実行中状態ではありませんでした。

    • the command is not applicable：コマンドは指定されたインスタンスに適用できません。

    • the specified account does not exists：指定されたアカウントは存在しません。

    • the specified directory does not exists：指定されたディレクトリは存在しません。

    • the cron job expression is invalid：実行時間を指定する cron 式が無効です。

    • the aliyun service is not running on the instance：クラウドアシスタントエージェントが実行されていません。

    • the aliyun service in the instance does not response：クラウドアシスタントエージェントが応答しません。

    • the aliyun service in the node is upgrading now：クラウドアシスタントエージェントはアップグレード中です。

    • the aliyun service in the node need upgrade：クラウドアシスタントエージェントをアップグレードする必要があります。

    • the command delivery has been timeout：コマンドの送信リクエストがタイムアウトしました。

    • the command execution has been timeout：コマンドの実行がタイムアウトしました。

    • the command execution got an exception：コマンドの実行中に例外が発生しました。

    • the command execution has been interrupted：コマンドの実行が中断されました。

    • the command execution exit code is not zero：コマンドの実行は完了しましたが、終了コードが 0 ではありません。

    • the specified instance has been released：ファイルの送信中にインスタンスがリリースされました。

    the specified instance does not exists
    CreationTime

    string

    ファイル送信タスクが作成された時刻。

    2023-02-06T07:12:50Z
    StartTime

    string

    開始時刻。

    2023-03-30T16:00:00Z
    UpdateTime

    string

    更新時刻。

    2023-03-30T16:00:00Z
    ErrorCode

    string

    インスタンスへのファイルの送信に失敗した場合に返されるエラーコード。有効な値は次のとおりです：

    Null：ファイルはインスタンスに送信されました。NodeNotExists：指定されたインスタンスが存在しないか、リリースされています。NodeReleased：ファイルの送信中にインスタンスがリリースされました。NodeNotRunning：ファイル送信タスクの作成中にインスタンスが実行されていませんでした。AccountNotExists：指定されたアカウントは存在しません。ClientNotRunning：クラウドアシスタントエージェントが実行されていません。ClientNotResponse：クラウドアシスタントエージェントが応答しませんでした。ClientIsUpgrading：クラウドアシスタントエージェントはアップグレード中でした。ClientNeedUpgrade：クラウドアシスタントエージェントをアップグレードする必要があります。DeliveryTimeout：ファイル送信タスクがタイムアウトしました。FileCreateFail：ファイルの作成に失敗しました。FileAlreadyExists：指定されたディレクトリに同じ名前のファイルが存在します。FileContentInvalid：ファイルの内容が無効です。FileNameInvalid：ファイル名が無効です。FilePathInvalid：指定されたディレクトリが無効です。FileAuthorityInvalid：ファイルに指定された権限が無効です。UserGroupNotExists：指定されたユーザーグループは存在しません。

    AccountNotExists

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "TotalCount": "1",
  "Invocations": {
    "Invocation": [
      {
        "FileMode": "0644",
        "Overwrite": true,
        "InvocationStatus": "Pending",
        "Description": "Description\n",
        "ContentType": "PlainText",
        "NodeCount": 3,
        "TargetDir": "\t/home/user",
        "FileGroup": "root",
        "FileOwner": "root",
        "Name": "test",
        "Content": "Base64",
        "CreationTime": "2023-04-10T10:53:46.156+08:00\n",
        "InvokeNodes": {
          "InvokeNode": [
            {
              "InvocationStatus": "Success",
              "FinishTime": "2023-04-10T10:53:46.156+08:00",
              "NodeId": "e01-cn-9lb3c15m81j",
              "ErrorInfo": "the specified instance does not exists",
              "CreationTime": "2023-02-06T07:12:50Z",
              "StartTime": "2023-03-30T16:00:00Z",
              "UpdateTime": "2023-03-30T16:00:00Z",
              "ErrorCode": "AccountNotExists"
            }
          ]
        }
      }
    ]
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。