すべてのプロダクト
Search

このプロダクト

    Security Center:DescribeExecutePlaybooks

    ドキュメントセンター

    Security Center:DescribeExecutePlaybooks

    最終更新日: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:DescribeExecutePlaybooks

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InputMode

    string

    任意

    プレイブックの入力パラメーターのエンティティタイプです。 複数のエンティティタイプを照会するには、コンマ (,) で区切ります。

    • ip：IP エンティティ。

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

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

    • incident：イベントエンティティ。

    ip,file,process,host
    PlaybookName

    string

    任意

    プレイブックの名前です。 あいまい検索がサポートされています。

    demo_test
    Uuid

    string

    任意

    プレイブックの UUID です。

    説明

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

    f916b93e-e814-459f-9662-xxxxxx
    Lang

    string

    任意

    リクエストと応答の言語。 有効値：

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

    • en：英語

    zh
    ParamType

    string

    任意

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

    • template-ip：IP リクエストテンプレート。

    • template-file：ファイルリクエストテンプレート。

    • template-process：プロセスリクエストテンプレート。

    • custom：カスタムパラメーター。

    custom

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータです。

    RequestId

    string

    リクエスト ID です。 この ID はリクエストに固有であり、Alibaba Cloud によって生成されます。 この ID を使用して、問題のトラブルシューティングを行ってください。

    88A39217-2802-5B1E-BA2B-CF1BBC43C1F5
    PlaybookMetrics

    array<object>

    プレイブックのリストです。

    object

    プレイブックの概要情報です。

    Description

    string

    プレイブックの説明です。

    a demo playbook
    DisplayName

    string

    プレイブックの名前です。

    demo_playbook
    Uuid

    string

    プレイブックの UUID です。

    c5c88b5e-97ca-435d-8c20-2xxxxx
    ParamConfig

    string

    プレイブックの入力パラメーターの構成です。 値は JSONArray フォーマットです。

    説明

    フォーマットの詳細については、「DescribePlaybookInputOutput」をご参照ください。

    [ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
    ParamType

    string

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

    • template-ip：IP リクエストテンプレート。

    • template-file：ファイルリクエストテンプレート。

    • template-process：プロセスリクエストテンプレート。

    • custom：カスタムパラメーター。

    custom

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "88A39217-2802-5B1E-BA2B-CF1BBC43C1F5",
  "PlaybookMetrics": [
    {
      "Description": "a demo playbook",
      "DisplayName": "demo_playbook",
      "Uuid": "c5c88b5e-97ca-435d-8c20-2xxxxx",
      "ParamConfig": "[\n    {\n        \"typeName\": \"String\",\n        \"dataClass\": \"normal\",\n        \"dataType\": \"String\",\n        \"description\": \"period\",\n        \"example\": \"\",\n        \"name\": \"period\",\n        \"required\": false\n    }\n]",
      "ParamType": "custom"
    }
  ]
}

    エラーコード

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

    変更履歴

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