DescribePlaybookInputOutput API パラメーターリファレンス - Security Center

今すぐお試しください

この 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: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。 Alibaba Cloud は、リクエストごとにこの一意の ID を生成します。この 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 パラメーターは JSON 配列フォーマットです。次のフィールドが含まれます：

typeName：パラメーターのタイプの名前。
dataClass：パラメーターのタイプのクラス。有効な値は、標準パラメーターの normal と、複雑なパラメーターの custom です。
dataType：パラメーターのデータの型。有効な値：string、long、int、ip、file、account。
description：パラメーターの説明。
example：パラメーター値の例。
name：パラメーターの名前。
required：パラメーターが必須かどうかを指定します。有効な値：true と false。

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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