剧本运行监控
功能介绍
剧本运行监控
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/monitor
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:32 最大长度:36 |
workspace_id |
是 |
String |
工作空间ID 最小长度:32 最大长度:36 |
playbook_id |
是 |
String |
剧本ID 最小长度:32 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start_time |
是 |
String |
开始时间。格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。例如:2021-01-30T23:00:00Z+0800。时区信息为剧本实例产生的时区,无法解析时区的时间,默认时区填东八区。 最小长度:18 最大长度:64 |
version_query_type |
是 |
String |
统计剧本版本类型(ALL:全部,VALID:有效的,DELETED:已删除) 最小长度:1 最大长度:20 枚举值:
|
end_time |
是 |
String |
结束时间。格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。例如:2021-01-30T23:00:00Z+0800。时区信息为剧本实例产生的时区,无法解析时区的时间,默认时区填东八区。 最小长度:18 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:2097152 |
content-type |
是 |
String |
application/json;charset=UTF-8 缺省值:application/json;charset=UTF-8 最小长度:1 最大长度:64 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 最小长度:1 最大长度:32 |
message |
String |
错误信息 最小长度:1 最大长度:32 |
data |
剧本运行监控详情 |
参数 |
参数类型 |
描述 |
---|---|---|
total_instance_run_num |
Integer |
运行总次数 最小值:0 最大值:99999999 |
schedule_instance_run_num |
Integer |
定时触发执行次数 最小值:0 最大值:99999999 |
event_instance_run_num |
Integer |
时间触发执行次数 最小值:0 最大值:99999999 |
average_run_time |
Number |
平均运行时间 最小值:0 最大值:9999999999 |
min_run_time_instance |
最短运行时间流程实例信息 |
|
max_run_time_instance |
最长运行时间流程实例信息 |
|
total_instance_num |
Integer |
剧本实例总数 最小值:0 最大值:99999999 |
success_instance_num |
Integer |
运行成功实例数量 最小值:0 最大值:99999999 |
fail_instance_num |
Integer |
运行失败实例数量 最小值:0 最大值:99999999 |
terminate_instance_num |
Integer |
运行终止实例数量 最小值:0 最大值:99999999 |
running_instance_num |
Integer |
运行中实例数量 最小值:0 最大值:99999999 |
参数 |
参数类型 |
描述 |
---|---|---|
playbook_instance_id |
String |
剧本实例ID 最小长度:0 最大长度:64 |
playbook_instance_name |
String |
剧本实例名称 最小长度:0 最大长度:64 |
playbook_instance_run_time |
Number |
剧本实例运行时间 最小值:0 最大值:9999999999 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 最小长度:0 最大长度:64 |
message |
String |
错误描述 最小长度:0 最大长度:1024 |
请求示例
无
响应示例
状态码: 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代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
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.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); ShowPlaybookMonitorsRequest request = new ShowPlaybookMonitorsRequest(); request.withStartTime("<start_time>"); request.withVersionQueryType(ShowPlaybookMonitorsRequest.VersionQueryTypeEnum.fromValue("<version_query_type>")); request.withEndTime("<end_time>"); 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()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 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"] credentials = BasicCredentials(ak, sk) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowPlaybookMonitorsRequest() request.start_time = "<start_time>" request.version_query_type = "<version_query_type>" request.end_time = "<end_time>" 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) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowPlaybookMonitorsRequest{} request.StartTime = "<start_time>" request.VersionQueryType = model.GetShowPlaybookMonitorsRequestVersionQueryTypeEnum().<VERSION_QUERY_TYPE> request.EndTime = "<end_time>" response, err := client.ShowPlaybookMonitors(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功响应信息 |
400 |
请求失败响应信息 |
错误码
请参见错误码。