すべてのプロダクト
Search

このプロダクト

    Backup and Disaster Recovery Center:DescribeTask

    ドキュメントセンター

    Backup and Disaster Recovery Center:DescribeTask

    最終更新日:Mar 30, 2026

    非同期タスクの詳細情報を取得します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    bdrc:DescribeTask

    none

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /api/v1/tasks/{TaskId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TaskId

    string

    必須

    タスクの ID です。タスク ID を取得するには、DescribeTasks 操作を呼び出してください。

    t-0004d9ctt1ii********

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスボディです。

    Data

    object

    返されたデータです。

    TaskId

    string

    タスクの ID です。

    t-xxxxxxxx
    TaskName

    string

    タスク名です。

    test5566
    TaskDescription

    string

    タスクの説明です。

    empty
    TaskType

    string

    タスクの種類です。有効な値は、UPDATE_RESOURCES（リソースおよびそのステータスの更新）および CHECK_RULES です。

    UPDATE_RESOURCES
    TaskPriority

    string

    タスクの優先度です。有効な値は、HIGH（通常、ユーザーが開始したタスクに使用）および LOW（通常、バックグラウンドタスクに使用）です。

    HIGH
    RequestId

    string

    リクエストの ID です。

    784076D6-BD6D-5564-9CEA-834EB11F0C62
    TaskDetail

    string

    タスク実行の詳細です。

    {"resourceTypes":["ACS::ECS::Instance","ACS::OSS::Bucket","ACS::OTS::Instance","ACS::NAS::FileSystem"]}
    ExecutionId

    string

    実行 ID です。このパラメーターは非推奨であり、常に空文字列を返します。

    empty
    Progress

    integer

    タスクの進捗状況で、0 ～ 10,000 の範囲で測定されます。

    100
    TaskStatus

    string

    タスクのステータスです。有効な値は、CREATED（作成済み）、RUNNING（実行中）、COMPLETE（完了）、FAILED（失敗）、EXPIRED（期限切れ）、および CANCELED（キャンセル済み）です。

    RUNNING
    ErrorMessage

    string

    タスクが失敗した場合に返されるエラーメッセージです。

    too many requests.
    StartTime

    integer

    開始時刻で、UNIX タイムスタンプ（秒単位）で表されます。

    1724983927
    CompleteTime

    integer

    完了時刻で、UNIX タイムスタンプ（秒単位）で表されます。

    1724983927
    ExpireTime

    integer

    有効期限で、UNIX タイムスタンプ（秒単位）で表されます。

    1719026680
    TaskResult

    string

    タスクの結果です。

    {"resourceCounts":[{"resourceType":"ACS::OSS::Bucket","count":2},{"resourceType":"ACS::NAS::FileSystem","count":3}]}
    RequestId

    string

    リクエストの ID です。

    14DFF801-A4E3-5136-AAB8-7D246012CD7A

    例

    成功レスポンス

    JSONJSON

    {
  "Data": {
    "TaskId": "t-xxxxxxxx",
    "TaskName": "test5566",
    "TaskDescription": " empty",
    "TaskType": "UPDATE_RESOURCES",
    "TaskPriority": "HIGH",
    "RequestId": "784076D6-BD6D-5564-9CEA-834EB11F0C62",
    "TaskDetail": "{\"resourceTypes\":[\"ACS::ECS::Instance\",\"ACS::OSS::Bucket\",\"ACS::OTS::Instance\",\"ACS::NAS::FileSystem\"]}",
    "ExecutionId": " empty",
    "Progress": 100,
    "TaskStatus": "RUNNING",
    "ErrorMessage": "too many requests.",
    "StartTime": 1724983927,
    "CompleteTime": 1724983927,
    "ExpireTime": 1719026680,
    "TaskResult": "{\"resourceCounts\":[{\"resourceType\":\"ACS::OSS::Bucket\",\"count\":2},{\"resourceType\":\"ACS::NAS::FileSystem\",\"count\":3}]}"
  },
  "RequestId": "14DFF801-A4E3-5136-AAB8-7D246012CD7A"
}

    エラーコード

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

    変更履歴

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