All Products
Search
Document Center

Security Center:DescribeExecutePlaybooks

Last Updated:Feb 01, 2024

Queries the playbooks that are available for an automatic response plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeExecutePlaybooksRead
  • acs:yundun-sas::{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PlaybookNamestringNo

The playbook name. Fuzzy search is supported.

demo_test
UuidstringNo

The playbook UUID.

Note You can call the DescribePlaybooks operation to query the playbook UUID.
f916b93e-e814-459f-9662-xxxxxx
LangstringNo

The language of the content within the request and the response. Valid values:

  • zh: Chinese (default)
  • en: English
zh
ParamTypestringNo

The input parameter type of the playbook.

  • template-ip
  • template-file
  • template-process
  • custom
custom

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

88A39217-2802-5B1E-BA2B-CF1BBC43C1F5
PlaybookMetricsobject []

The playbook.

Descriptionstring

The playbook description.

a demo playbook
DisplayNamestring

The playbook name.

demo_playbook
Uuidstring

The playbook UUID.

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

The configuration of the input parameter. The value is a JSON array.

Note For more information, see DescribePlaybookInputOutput .
[ { "typeName": "String", "dataClass": "normal", "dataType": "String", "description": "period", "example": "", "name": "period", "required": false } ]
ParamTypestring

The input parameter type of the playbook.

  • template-ip
  • template-file
  • template-process
  • custom
custom

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history