# 剧本运行监控 - ShowPlaybookMonitors #### 功能介绍 剧本运行监控（待下线） #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/monitor 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | | workspace_id | 是 | String | 工作空间ID | | playbook_id | 是 | String | 剧本ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 是 | String | 开始时间。格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。例如：2021-01-30T23:00:00Z+0800。时区信息为剧本实例产生的时区，无法解析时区的时间，默认时区填东八区。 | | version_query_type | 是 | String | 统计剧本版本类型（ALL:全部，VALID:有效的，DELETED:已删除） | | end_time | 是 | String | 结束时间。格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。例如：2021-01-30T23:00:00Z+0800。时区信息为剧本实例产生的时区，无法解析时区的时间，默认时区填东八区。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json **默认取值：** application/json | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | | X-API-Deprecation-Date | String | 下线时间： 2026-12-31 | | X-API-Deprecation-Info | String | API即将下线，可以使用指标接口查询剧本监控数据，指标ID： 37929579-b24d-40e9-96d5-5574c8506403 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码 | | message | String | 错误信息 | | data | [PlaybookInstanceMonitorDetail] object | 剧本运行监控详情 | 表6PlaybookInstanceMonitorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_instance_run_num | Integer | 运行总次数 | | schedule_instance_run_num | Integer | 定时触发执行次数 | | event_instance_run_num | Integer | 时间触发执行次数 | | average_run_time | Number | 平均运行时间 | | min_run_time_instance | [PlaybookInstanceRunStatistics] object | 最短运行时间流程实例信息 | | max_run_time_instance | [PlaybookInstanceRunStatistics] object | 最长运行时间流程实例信息 | | total_instance_num | Integer | 剧本实例总数 | | success_instance_num | Integer | 运行成功实例数量 | | fail_instance_num | Integer | 运行失败实例数量 | | terminate_instance_num | Integer | 运行终止实例数量 | | running_instance_num | Integer | 运行中实例数量 | 表7PlaybookInstanceRunStatistics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | playbook_instance_id | String | 剧本实例ID | | playbook_instance_name | String | 剧本实例名称 | | playbook_instance_run_time | Number | 剧本实例运行时间 | **状态码：400** 表8响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | | X-API-Deprecation-Date | String | 下线时间： 2026-12-31 | | X-API-Deprecation-Info | String | API即将下线，如果需要克隆剧本版本可以直接使用CreatePlaybookVersion接口 | 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **取值范围**: 不涉及 | | message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** 请求成功响应信息 ``` { "code" : "00000000", "message" : "", "data" : { "total_instance_run_num" : "Unknown Type: in", "schedule_instance_run_num" : 99999999, "event_instance_run_num" : 99999999, "average_run_time" : 9999999999, "min_run_time_instance" : { "playbook_instance_id" : "string", "playbook_instance_name" : "string", "playbook_instance_run_time" : 9999999999 }, "max_run_time_instance" : { "playbook_instance_id" : "string", "playbook_instance_name" : "string", "playbook_instance_run_time" : 9999999999 }, "total_instance_num" : 99999999, "success_instance_num" : 99999999, "fail_instance_num" : 99999999, "terminate_instance_num" : 99999999, "running_instance_num" : 99999999 } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class ShowPlaybookMonitorsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("")) .build(); ShowPlaybookMonitorsRequest request = new ShowPlaybookMonitorsRequest(); request.withWorkspaceId("{workspace_id}"); request.withPlaybookId("{playbook_id}"); try { ShowPlaybookMonitorsResponse response = client.showPlaybookMonitors(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("")) \ .build() try: request = ShowPlaybookMonitorsRequest() request.workspace_id = "{workspace_id}" request.playbook_id = "{playbook_id}" response = client.show_playbook_monitors(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ShowPlaybookMonitorsRequest{} request.WorkspaceId = "{workspace_id}" request.PlaybookId = "{playbook_id}" response, err := client.ShowPlaybookMonitors(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ShowPlaybookMonitors&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功响应信息 | | 400 | 请求失败响应信息 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。