使用DescribePlaybookMetrics查询剧本元信息-云安全中心-阿里云

获取某一剧本的元信息，包括名字、描述、运行次数、失败率等。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribePlaybookMetrics

get

*Playbook

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

无

请求参数

名称	类型	必填	描述	示例值
PlaybookUuid	string	是	剧本的 UUID。说明调用 DescribePlaybooks 接口可以获取该参数。	2a687089-d4dd-47d4-9709-xxxxxx
Lang	string	否	设置请求和接收消息的语言类型，默认为 zh。取值： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	567D3D0B-2153-5860-BF9A-F9DEED55FB73
Metrics	object	剧本的信息详情。
DisplayName	string	剧本的名称。	demo name
PlaybookUuid	string	剧本的 UUID。	0fbc9bdb-9ae3-4ef4-a709-xxxxx
OwnType	string	剧本的类型，取值： preset：预定义剧本。 user：自定义剧本。	user
Active	integer	剧本的启用状态，取值： 1：表示剧本已启用。 0：表示剧本未启用	1
LastRuntime	integer	剧本的最后执行时间，格式：13 位的时间戳。	1683526277415
GmtCreate	integer	剧本创建时间，格式：13 位的时间戳。	1655277397000
HistoryMd5	integer	剧本历史版本个数。	10
SuccNum	integer	剧本任务执行成功数。	100
FailNum	integer	剧本任务执行失败数。	10
Description	string	剧本的描述信息。	This is a playbook for waf processing

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。