DescribeComponentPlaybook - Security Center - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeComponentPlaybook

get

*Playbook

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

None

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	Yes	The UUID of the component playbook. Note Call the DescribePlaybooks operation to obtain this parameter.	ac343acc-1a61-4084-9a1cxxxxx
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	C5F5D6C9-DF1A-5381-92B1-39676F777D20
Playbooks	array<object>	The list of component playbooks.
	object	The information about the component playbook.
DisplayName	string	The name of the component playbook.	AegisKillQuara
InputParams	string	The input parameter configurations of the component playbook. The value is a JSON array. Note For more information about the format, see DescribePlaybookInputOutput.	[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
Description	string	The description of the component playbook.	aegis_kill_process
ParamType	string	The input parameter type of the component playbook. template-ip: IP request template. template-file: file request template. template-process: process request template. custom: custom parameters.	template-alert

Examples

Success response

JSON format

{
  "RequestId": "C5F5D6C9-DF1A-5381-92B1-39676F777D20",
  "Playbooks": [
    {
      "DisplayName": "AegisKillQuara",
      "InputParams": "[\n    {\n        \"typeName\": \"String\",\n        \"dataClass\": \"normal\",\n        \"dataType\": \"String\",\n        \"description\": \"period\",\n        \"example\": \"\",\n        \"name\": \"period\",\n        \"required\": false\n    }\n]",
      "Description": "aegis_kill_process",
      "ParamType": "template-alert"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.