获取某一剧本的元信息,包括名字、描述、运行次数、失败率等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PlaybookUuid | string | 是 | 剧本的 UUID。 说明
调用 DescribePlaybooks 接口可以获取该参数。
| 2a687089-d4dd-47d4-9709-xxxxxx |
Lang | string | 否 | 设置请求和接收消息的语言类型,默认为 zh。取值:
| zh |
返回参数
示例
正常返回示例
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"
}
}
错误码
访问错误中心查看更多错误码。