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

Security Center:DescribeSoarTaskAndActions

最終更新日:Dec 11, 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-sas:DescribeSoarTaskAndActions

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RequestUuid

string

任意

プレイブックタスクの UUID。

1077f2f9-25e8-42d9-bfdf-1528e1313f6d

Lang

string

任意

リクエストとレスポンスの言語。有効な値:

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

  • en:英語

zh

PageNumber

integer

任意

ページ番号。デフォルト値:1。

1

PageSize

integer

任意

各ページに返すエントリの数。最大値は 20 です。このパラメーターを指定しない場合、10 エントリが返されます。

説明

このパラメーターの値を指定します。

10

QueryValue

string

任意

プレイブックの入力パラメーター。

input

QueryType

string

任意

タスクのトリガータイプ。有効な値:

  • stream:タスクはデータストリームによってトリガーされます。

  • debug:タスクはデバッグプロセスによってトリガーされます。

  • manual:タスクは手動でトリガーされます。

  • timer:タスクはタイマーによってトリガーされます。

  • SubInvoke:タスクは子フローによってトリガーされます。

debug

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

RequestId

string

リクエストの ID。

18017A93-3D5D-503A-8308-914543F1CBA3

Details

object

タスク実行の詳細。

TriggerType

string

トリガータイプ。有効な値:

  • debug:プレイブックをデバッグするためのタスク。

  • manual:手動でトリガーされたタスク。

  • siem:イベントによってトリガーされたタスク。

siem

TaskName

string

プレイブックタスクの名前。これはプレイブックの UUID と同じです。

92af3c79-1754-4646-9366-9ddbd1e45536

StartTime

integer

プレイブック実行の開始時刻。これは 13 桁のタイムスタンプです。

1699868848645

EndTime

integer

プレイブック実行の終了時刻。これは 13 桁のタイムスタンプです。

1699868848767

Status

string

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

  • success:タスクは成功しました。

  • fail:タスクは失敗しました。

  • running:タスクは実行中です。

success

RequestUuid

string

プレイブックタスクのリクエスト ID。これは、各タスク実行の一意の ID です。

17f75844-75cc-4174-86da-cec07a690142

TriggerUser

string

プレイブックタスクをトリガーした Alibaba Cloud アカウントの ID。

127xxxx4392

ErrorMsg

string

プレイブックタスクのエラーメッセージ。タスクが成功した場合、このフィールドは空です。

stime not match

RawEventReq

string

プレイブックタスクのリクエストパラメーター。

{ "input1": "xx.xx.xx.xx", "input2": "7d" }

Actions

array<object>

プレイブックで実行されたコンポーネントアクションのリスト。

object

プレイブックで実行されたコンポーネントアクションの詳細。

Component

string

コンポーネントの名前。

DataFormat

Action

string

コンポーネントアクションの名前。

formatdata

StartTime

integer

コンポーネント実行の開始時刻。これは 13 桁のタイムスタンプです。

1699868848731

EndTime

integer

コンポーネント実行の終了時刻。これは 13 桁のタイムスタンプです。

1699868848766

Status

string

コンポーネント実行の結果。有効な値:

  • success:実行は成功しました。

  • fail:実行は失敗しました。

success

ActionUuid

string

コンポーネントアクション実行レコードの UUID。

091be399-a937-4276-af78-xxxxxxxx

AssetName

string

コンポーネントで使用されるアセットの名前。

SLS Asset

NodeName

string

コンポーネントのカスタムノード名。

DataFormat_1

TaskFlowMd5

string

実行されたプレイブック構成の MD5 値。

ed127287-6699-4e4d-b986-9f770879xxx

ActionLogNum

integer

アクションログの総数。

5

Page

object

ページネーション情報。

TotalCount

string

返されたエントリの総数。

20

PageNumber

string

返されたページのページ番号。

1

PageSize

string

1 ページあたりに返されるエントリの数。

10

成功レスポンス

JSONJSON

{
  "RequestId": "18017A93-3D5D-503A-8308-914543F1CBA3",
  "Details": {
    "TriggerType": "siem",
    "TaskName": "92af3c79-1754-4646-9366-9ddbd1e45536",
    "StartTime": 1699868848645,
    "EndTime": 1699868848767,
    "Status": "success",
    "RequestUuid": "17f75844-75cc-4174-86da-cec07a690142",
    "TriggerUser": "127xxxx4392",
    "ErrorMsg": "stime not match",
    "RawEventReq": "{\n    \"input1\": \"xx.xx.xx.xx\",\n    \"input2\": \"7d\"\n}",
    "Actions": [
      {
        "Component": "DataFormat",
        "Action": "formatdata",
        "StartTime": 1699868848731,
        "EndTime": 1699868848766,
        "Status": "success",
        "ActionUuid": "091be399-a937-4276-af78-xxxxxxxx",
        "AssetName": "SLS Asset",
        "NodeName": "DataFormat_1"
      }
    ],
    "TaskFlowMd5": "ed127287-6699-4e4d-b986-9f770879xxx",
    "ActionLogNum": 5
  },
  "Page": {
    "TotalCount": "20",
    "PageNumber": "1",
    "PageSize": "10"
  }
}

エラーコード

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

変更履歴

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