DescribePlaybookMetrics - Security Center - Alibaba Cloud Documentation Center

Queries playbook metadata, including its name, description, number of runs, and failure rate.

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:DescribePlaybookMetrics

get

*Playbook

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

None

Request parameters

Parameter	Type	Required	Description	Example
PlaybookUuid	string	Yes	The UUID of the playbook. Note Call the DescribePlaybooks operation to obtain this parameter.	2a687089-d4dd-47d4-9709-xxxxxx
Lang	string	No	The language of the request and response. The default value is zh. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request. This ID is unique to each request and is used for troubleshooting.	567D3D0B-2153-5860-BF9A-F9DEED55FB73
Metrics	object	The details of the playbook.
DisplayName	string	The name of the playbook.	demo name
PlaybookUuid	string	The UUID of the playbook.	0fbc9bdb-9ae3-4ef4-a709-xxxxx
OwnType	string	The type of the playbook. Valid values: preset: predefined playbook. user: custom playbook.	user
Active	integer	The status of the playbook. Valid values: 1: The playbook is enabled. 0: The playbook is disabled.	1
LastRuntime	integer	The time when the playbook was last run. The value is a 13-digit timestamp.	1683526277415
GmtCreate	integer	The time when the playbook was created. The value is a 13-digit timestamp.	1655277397000
HistoryMd5	integer	The number of historical versions of the playbook.	10
SuccNum	integer	The number of successful playbook runs.	100
FailNum	integer	The number of failed playbook runs.	10
Description	string	The description of the playbook.	This is a playbook for waf processing

Examples

Success response

JSON format

{
  "RequestId": "567D3D0B-2153-5860-BF9A-F9DEED55FB73",
  "Metrics": {
    "DisplayName": "demo name",
    "PlaybookUuid": "0fbc9bdb-9ae3-4ef4-a709-xxxxx",
    "OwnType": "user",
    "Active": 1,
    "LastRuntime": 1683526277415,
    "GmtCreate": 1655277397000,
    "HistoryMd5": 10,
    "SuccNum": 100,
    "FailNum": 10,
    "Description": "This is a playbook for waf processing"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.