すべてのプロダクト
Search
ドキュメントセンター

Cloud Firewall:DescribeFirewallTask

最終更新日:Aug 01, 2026

ファイアウォールタスクを取得します。

操作説明

QPS 制限

この操作の単一ユーザー QPS 制限は、1 秒あたり 10 回の呼び出しです。制限を超えると、API の呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作は適切に呼び出してください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-cloudfirewall:DescribeFirewallTask

get

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Lang

string

任意

言語タイプ。有効な値:

  • zh (デフォルト): 中国語

  • en: 英語

zh

ChildInstanceId

string

任意

サブインスタンスの ID。ChildInstanceId と TaskId の少なくとも一方を指定する必要があります。両方が空の場合、エラー MissingParameter.TaskId (-360448) が返されます。

vfw-tr-cd6000c588214403****

TaskType

string

任意

タスクのタイプ。有効な値:

  • NAT: NAT ファイアウォールタスク

  • VPC: VPC ファイアウォールタスク

VPC

TaskId

string

任意

タスクの ID。TaskId と ChildInstanceId の少なくとも一方は必須です。両方が空の場合、エラー MissingParameter.TaskId (-360448, At least one of TaskId or ChildInstanceId is required.) が返されます。

199431783

レスポンスフィールド

フィールド

説明

object

IsFound

boolean

タスクが存在するかどうかを示します。

false

TaskStatus

string

タスクのステータス。有効な値:

  • init

  • running: 実行中

  • finished

  • rollback: ロールバック

  • rollbackDone

init

TaskWaitingTime

string

待機時間 (分単位)。

30

TaskSteps

array<object>

タスクステップ。

object

タスクステップ。

StepStatus

string

タスクステップのステータス。有効な値:

  • init

  • running: 実行中

  • finished

  • failed: 失敗した

init

StepName

string

Cloud Firewall セキュリティステップの名前。

Create Firewall

StepProgress

string

タスクステップの進捗状況。

80

StepInfo

string

タスク情報。

abcd

RequestId

string

リクエスト ID。

7D5483BF-2262-586D-8706-BDDB8B42****

TaskName

string

タスク名。

egressgw

TaskStartTimestamp

string

タスクが作成された時間。

17151361285

TaskFinishTimestamp

string

タスクが完了した時間。

17151381075

TaskId

integer

タスクの ID。

189997648

成功レスポンス

JSONJSON

{
  "IsFound": true,
  "TaskStatus": "init。",
  "TaskWaitingTime": "30",
  "TaskSteps": [
    {
      "StepStatus": "init。",
      "StepName": "ファイアウォールの作成。",
      "StepProgress": "80",
      "StepInfo": "abcd。"
    }
  ],
  "RequestId": "7D5483BF-2262-586D-8706-BDDB8B42****",
  "TaskName": "egressgw。",
  "TaskStartTimestamp": "17151361285",
  "TaskFinishTimestamp": "17151381075",
  "TaskId": 189997648
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 ErrorParameters A parameter error occurred.
400 MissingParameter.TaskId At least one of TaskId or ChildInstanceId is required.

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

変更履歴

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