DescribePlaybookInputOutput API參數參考 - Security Center

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sas:DescribePlaybookInputOutput

get

*Playbook

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

無

請求參數

名稱	類型	必填	描述	樣本值
PlaybookUuid	string	是	劇本的 UUID。說明調用 DescribePlaybooks 介面可以擷取該參數。	b724d2b0-3c3b-4223-9bfd-xxxxxxx
Lang	string	否	佈建要求和接收訊息的語言類型，預設為 zh。取值： zh：中文 en：英文	zh

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。	688B4CCD-5272-5DCF-9D76-FE5EFEF545F8
Config	object	配置資訊。
ParamType	string	劇本的入參類型。 template-ip：IP 請求模板。 template-file：檔案請求模板。 template-process：進程請求模板。 custom：自訂參數。	custom
ExeConfig	string	劇本的執行方式，為 JSONObject 格式。	{ "executeMode":"mul", "cron":"0 0 1 /1 ?" }
InputParams	string	劇本的入參配置，為 JSONArray 格式。	[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
OutputParams	string	劇本暫不支援出參配置，固定為空白值。	[]
PlaybookUuid	string	劇本的 UUID。	9030076b-6733-4842-b05a-xxxxxx

InputParams 為 JSONArray 格式，具體參數說明：

typeName：參數類型名稱。
dataClass：參數類型等級，可選值，normal 表示普通參數，custom 表示複雜參數。
dataType：參數類型，可選值，string、long、int、ip、file、account。
description：參數的描述說明。
example：參數的樣本。
name：參數名稱。
required：參數是否必填，可選值，true 表示必填，false 表示不必填

樣本

正常返回樣本

JSON格式

{
  "RequestId": "688B4CCD-5272-5DCF-9D76-FE5EFEF545F8",
  "Config": {
    "ParamType": "custom",
    "ExeConfig": "{\n   \"executeMode\":\"mul\",\n  \"cron\":\"0 0 1 */1 * ?\"\n}",
    "InputParams": "[\n    {\n        \"typeName\": \"String\",\n        \"dataClass\": \"normal\",\n        \"dataType\": \"String\",\n        \"description\": \"period\",\n        \"example\": \"\",\n        \"name\": \"period\",\n        \"required\": false\n    }\n]",
    "OutputParams": "[]",
    "PlaybookUuid": "9030076b-6733-4842-b05a-xxxxxx"
  }
}

錯誤碼

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

變更歷史

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