すべてのプロダクト
Search

このプロダクト

    Security Center:DescribePlaybooks

    ドキュメントセンター

    Security Center:DescribePlaybooks

    最終更新日:Dec 11, 2025

    プレイブックのリストをクエリします。

    操作説明

    この操作を呼び出す前に、Security Orchestration, Automation, and Response (SOAR) の課金方法と価格について理解していることを確認してください。

    今すぐお試しください

    この 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:DescribePlaybooks

    get

    *Playbook

    acs:yundun-sas::{#accountId}:playbook/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Active

    integer

    任意

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

    • 1：プレイブックは有効です。

    • 0：プレイブックは無効です。

    1
    OwnType

    string

    任意

    プレイブックのタイプ。有効な値：

    • preset：事前定義済みのプレイブック。

    • user：カスタムプレイブック。

    user
    StartMillis

    integer

    任意

    クエリする時間範囲の開始時刻。この値は 13 桁のタイムスタンプです。

    1683526277415
    EndMillis

    integer

    任意

    クエリする時間範囲の終了時刻。この値は 13 桁のタイムスタンプです。

    1683858064361
    PlaybookUuid

    string

    任意

    プレイブックの UUID。

    説明

    CreatePlaybook 操作を呼び出してこのパラメーターを取得します。

    8baa6cff-319e-4ede-97bc-1xxxxxx
    Name

    string

    任意

    プレイブックの名前。

    demo_playbook
    Lang

    string

    任意

    リクエストと応答内のコンテンツの言語。デフォルト値：zh。有効な値：

    • zh：中国語。

    • en：英語。

    zh
    PageSize

    integer

    任意

    各ページで返すエントリ数。デフォルト値：20。このパラメーターを空のままにすると、デフォルトで 10 件のエントリが返されます。

    説明

    このパラメーターの値を指定してください。

    10
    PageNumber

    integer

    任意

    返すページのページ番号。デフォルト値：1。

    1
    Sort

    integer

    任意

    ソートするフィールド。デフォルト値：1。有効な値：

    • 1：最終変更時間。

    • 2：最終実行時間。

    1
    Order

    string

    任意

    ソート順。デフォルト値：desc。有効な値：

    • desc：降順。

    • asc：昇順。

    desc
    ParamTypes

    string

    任意

    プレイブックのトリガータイプ。このパラメーターを指定しない場合、すべてのトリガータイプのプレイブックがクエリされます。有効な値：

    • template-incident：セキュリティイベント。

    • template-ip：IP エンティティ。

    • template-file：ファイルエンティティ。

    • template-process：プロセスエンティティ。

    • template-alert：セキュリティアラート。

    • template-domain：ドメイン名エンティティ。

    • template-container：コンテナーエンティティ。

    • template-host：ホストエンティティ。

    • template-custom：カスタム。

    template-alert
    PlaybookUuids

    string

    任意

    コンマ区切りのプレイブック UUID のリスト。最大 100 個の UUID を指定できます。

    8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    RequestId

    string

    リクエスト ID。この ID は Alibaba Cloud によってリクエストに対して生成され、問題のトラブルシューティングに使用できます。

    138B5AB7-****-5814-87A3-E3E****F207E
    Playbooks

    array<object>

    プレイブックのリスト。

    object

    プレイブックに関する情報。

    DisplayName

    string

    プレイブックの表示名。

    demo_playbook
    PlaybookUuid

    string

    プレイブックの UUID。

    bb5a8640-a14f-44ef-8376-cxxxxx
    OwnType

    string

    プレイブックのタイプ。有効な値：

    • preset：事前定義済みのプレイブック。

    • user：カスタムプレイブック。

    user
    Active

    integer

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

    • 1：プレイブックは有効です。

    • 0：プレイブックは無効です。

    1
    LastRuntime

    integer

    プレイブックの最終実行時間。この値は 13 桁のタイムスタンプです。

    1683526277415
    GmtCreate

    integer

    プレイブックが作成された時間。この値は 13 桁のタイムスタンプです。

    1683526277415
    GmtModified

    string

    プレイブックが変更された時間。

    1681396398000
    ParamType

    string

    プレイブックのトリガータイプ。有効な値：

    • template-incident：セキュリティイベント。

    • template-ip：IP エンティティ。

    • template-file：ファイルエンティティ。

    • template-process：プロセスエンティティ。

    • template-alert：セキュリティアラート。

    • template-domain：ドメイン名エンティティ。

    • template-container：コンテナーエンティティ。

    • template-host：ホストエンティティ。

    template-alert
    Description

    string

    プレイブックの説明。

    aegis_kill_process
    TenantId

    string

    プレイブックが属するユーザーの ID。

    123456
    Page

    object

    ページネーション情報。

    TotalCount

    integer

    クエリに一致するエントリの総数。

    100
    PageNumber

    integer

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

    1
    PageSize

    integer

    ページごとに返されるエントリ数。

    10

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "138B5AB7-****-5814-87A3-E3E****F207E",
  "Playbooks": [
    {
      "DisplayName": "demo_playbook",
      "PlaybookUuid": "bb5a8640-a14f-44ef-8376-cxxxxx",
      "OwnType": "user",
      "Active": 1,
      "LastRuntime": 1683526277415,
      "GmtCreate": 1683526277415,
      "GmtModified": "1681396398000",
      "ParamType": "template-alert",
      "Description": "aegis_kill_process",
      "TenantId": "123456"
    }
  ],
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

    エラーコード

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

    変更履歴

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