Playbook Running Monitoring
Function
Playbook Running Monitoring
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/monitor
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 32 Maximum: 36 |
workspace_id |
Yes |
String |
Workspace ID Minimum: 32 Maximum: 36 |
playbook_id |
Yes |
String |
Playbook ID. Minimum: 32 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_time |
Yes |
String |
Start time.The format is ISO 8601- YYYY-MM-DDTHH:mm:ss.ms+Time zone. For example, 2021-01-30T23:00:00Z+0800. Time zone is where the playbook instances occured. If this parameter cannot be parsed, the default time zone GMT+8 is used. Minimum: 18 Maximum: 64 |
version_query_type |
Yes |
String |
Playbook version type. The options are ALL, VALID, and DELETED. Minimum: 1 Maximum: 20 Enumeration values:
|
end_time |
Yes |
String |
End time.The format is ISO 8601- YYYY-MM-DDTHH:mm:ss.ms+Time zone. For example, 2021-01-30T23:00:00Z+0800. Time zone is where the playbook instances occured. If this parameter cannot be parsed, the default time zone GMT+8 is used. Minimum: 18 Maximum: 64 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 1 Maximum: 2097152 |
content-type |
Yes |
String |
application/json;charset=UTF-8 Default: application/json;charset=UTF-8 Minimum: 1 Maximum: 64 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code Minimum: 1 Maximum: 32 |
message |
String |
Error Message Minimum: 1 Maximum: 32 |
data |
Playbook monitoring details. |
Parameter |
Type |
Description |
---|---|---|
total_instance_run_num |
Integer |
Total running times. Minimum: 0 Maximum: 99999999 |
schedule_instance_run_num |
Integer |
Scheduled executions. Minimum: 0 Maximum: 99999999 |
event_instance_run_num |
Integer |
Time-triggered executions. Minimum: 0 Maximum: 99999999 |
average_run_time |
Number |
Average duration. Minimum: 0 Maximum: 9999999999 |
min_run_time_instance |
Workflow with the shortest running duration. |
|
max_run_time_instance |
Workflow with the longest running duration. |
|
total_instance_num |
Integer |
Total number of playbook instances. Minimum: 0 Maximum: 99999999 |
success_instance_num |
Integer |
Number of successful instances. Minimum: 0 Maximum: 99999999 |
fail_instance_num |
Integer |
Failed instances. Minimum: 0 Maximum: 99999999 |
terminate_instance_num |
Integer |
Number of terminated instances. Minimum: 0 Maximum: 99999999 |
running_instance_num |
Integer |
Number of running instances. Minimum: 0 Maximum: 99999999 |
Parameter |
Type |
Description |
---|---|---|
playbook_instance_id |
String |
Playbook instance ID. Minimum: 0 Maximum: 64 |
playbook_instance_name |
String |
Playbook instance name. Minimum: 0 Maximum: 64 |
playbook_instance_run_time |
Number |
Playbook instance running time. Minimum: 0 Maximum: 9999999999 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error Code Minimum: 0 Maximum: 64 |
message |
String |
Error Description Minimum: 0 Maximum: 1024 |
Example Requests
None
Example Responses
Status code: 200
Response when the request is successful.
{ "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 Sample Code
The SDK sample code is as follows.
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Response when the request is successful. |
400 |
Response when the request failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot