調用DescribeExecutePlaybooks擷取可執行檔劇本列表-Security Center-阿里雲

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sas:DescribeExecutePlaybooks

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
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，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。	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

樣本

正常返回樣本

JSON格式

{
  "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"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。