すべてのプロダクト
Search

このプロダクト

    Cloud Storage Gateway:DescribeTasks

    ドキュメントセンター

    Cloud Storage Gateway:DescribeTasks

    最終更新日:Dec 18, 2025

    タスクの進捗や名前などのタスク情報を照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hcs-sgw:DescribeTasks

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TargetId

    string

    必須

    ゲートウェイまたは高速同期グループの ID。

    sync-0001xv757xl9sn548***
    PageNumber

    integer

    任意

    ページ番号。

    • ページは 1 から始まります。

    • デフォルト値：1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。

    • 最大値：50。

    • デフォルト値：10。

    10
    TaskId

    string

    任意

    タスク ID。このパラメーターを空のままにすると、すべてのタスクが照会されます。

    t-0001xv7je357xl9n***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    タスクの総数。

    1
    Tasks

    object

    SimpleTask

    array<object>

    タスク情報。

    object

    StateCode

    string

    タスクの状態コード。有効値：

    • task.state.Initialized

    • task.state.Running

    • task.state.completed

    • task.state.Failed

    task.state.completed
    Progress

    integer

    タスクの進捗率 (%)。

    100
    UpdatedTime

    integer

    タスクが最後に変更されたときのタイムスタンプ。単位：秒。

    1578367230
    MessageKey

    string

    返されるエラーメッセージ。

    xxx
    Name

    string

    タスク名。

    task.name.operate_fast_sync.delete
    CreatedTime

    integer

    タスクが作成されたときのタイムスタンプ。単位：秒。

    1578367229
    TaskId

    string

    タスク ID。

    t-0001xv7je357xl9n***
    RelatedResourceId

    string

    関連リソースの ID。

    NFSnfstest
    RequestId

    string

    リクエスト ID。

    8E9C6D43-4603-4F05-BE76-677A05EDFB7A
    Message

    string

    返されるメッセージ。

    successful
    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    PageNumber

    integer

    ページ番号。

    1
    Code

    string

    状態コード。状態コード 200 は、リクエストが成功したことを示します。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "Tasks": {
    "SimpleTask": [
      {
        "StateCode": "task.state.completed",
        "Progress": 100,
        "UpdatedTime": 1578367230,
        "MessageKey": "xxx",
        "Name": "task.name.operate_fast_sync.delete",
        "CreatedTime": 1578367229,
        "TaskId": "t-0001xv7je357xl9n***",
        "RelatedResourceId": "NFSnfstest"
      }
    ]
  },
  "RequestId": "8E9C6D43-4603-4F05-BE76-677A05EDFB7A",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Code": "200",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 EmptyTargetId You must enter a valid ID for the target gateway.
    400 BadPageSize The specified number of pages is invalid. The number ranges from 1 to 50.
    400 BadPageNumber The specified page number is invalid. The page number must be greater than 0.

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

    変更履歴

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