Querying Playbook Instance Audit Logs
Function
Querying Playbook Instance Audit Logs
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/auditlogs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 32 Maximum: 36 |
workspace_id |
Yes |
String |
Workspace ID Minimum: 32 Maximum: 36 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
Yes |
Long |
offset Minimum: 0 Maximum: 9223372036854775807 |
limit |
Yes |
Long |
limit Minimum: 10 Maximum: 50 |
sort_key |
No |
String |
sort_key Minimum: 1 Maximum: 256 |
sort_dir |
No |
String |
sort_dir. asc, desc Enumeration values:
|
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_type |
No |
String |
Instance type (AOP_WORKFLOW for workflows, SCRIPT for scripts, and PLAYBOOK for playbooks). Minimum: 0 Maximum: 64 |
action_id |
No |
String |
Workflow ID. Minimum: 0 Maximum: 1028 |
action_name |
No |
String |
Workflow name. Minimum: 0 Maximum: 64 |
instance_id |
No |
String |
Instance ID. Minimum: 0 Maximum: 1028 |
parent_instance_id |
No |
String |
Instance ID of the parent node. Minimum: 0 Maximum: 64 |
log_level |
No |
String |
Log Level Minimum: 0 Maximum: 1028 |
input |
No |
String |
Input. Minimum: 0 Maximum: 64 |
output |
No |
String |
Output. Minimum: 0 Maximum: 1028 |
error_msg |
No |
String |
Error Message Minimum: 0 Maximum: 64 |
start_time |
No |
String |
Start time. Minimum: 0 Maximum: 1028 |
end_time |
No |
String |
End time. Minimum: 0 Maximum: 64 |
status |
No |
String |
Status. (RUNNING, FINISHED, FAILED, RETRYING, and TERMINATED) Minimum: 0 Maximum: 1028 |
trigger_type |
No |
String |
Triggering type. TIMER indicates scheduled triggering, and EVENT indicates event triggering. Minimum: 0 Maximum: 1028 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total records. Minimum: 0 Maximum: 99999 |
audit_logs |
Array of AuditLogInfo objects |
Review response list. Array Length: 0 - 100 |
Parameter |
Type |
Description |
---|---|---|
instance_type |
String |
Instance type (AOP_WORKFLOW for workflows, SCRIPT for scripts, and PLAYBOOK for playbooks). Minimum: 0 Maximum: 64 |
action_id |
String |
Workflow ID. Minimum: 0 Maximum: 1028 |
action_name |
String |
Workflow name. Minimum: 0 Maximum: 64 |
instance_id |
String |
Instance ID. Minimum: 0 Maximum: 1028 |
parent_instance_id |
String |
Instance ID of the parent node. Minimum: 0 Maximum: 64 |
log_level |
String |
Log Level Minimum: 0 Maximum: 1028 |
input |
String |
Input. Minimum: 0 Maximum: 64 |
output |
String |
Output. Minimum: 0 Maximum: 1028 |
error_msg |
String |
Error Message Minimum: 0 Maximum: 64 |
start_time |
String |
Start time. Minimum: 0 Maximum: 1028 |
end_time |
String |
End time. Minimum: 0 Maximum: 64 |
status |
String |
Status. (RUNNING, FINISHED, FAILED, RETRYING, and TERMINATED) Minimum: 0 Maximum: 1028 |
trigger_type |
String |
Triggering type. TIMER indicates scheduled triggering, and EVENT indicates event triggering. Minimum: 0 Maximum: 1028 |
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
Query playbook instance review logs. Details - Instance type - APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG; Workflow ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Workflow name - DisabledIp; Instance ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Parent instance ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Log level - DEBUG, INFO WARN; Input - input; Output - output; Error message - error_msg. Start time - 2021-01-30 23:00:00;End time - 2021-01-31 23:00:00; Status - CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED Trigger type - DEBUG, TIMER, EVENT, or MANUAL.
{ "instance_type" : "APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "action_name" : "DisabledIp", "instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "parent_instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "log_level" : "DEBUG INFO WARN", "input" : "input", "output" : "output", "error_msg" : "error_msg", "start_time" : "2021-01-30T23:00:00Z", "end_time" : "2021-01-31T23:00:00Z", "status" : "CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED", "trigger_type" : "DEBUG, TIMER, EVENT, MANUAL" }
Example Responses
Status code: 200
Response when the request is successful.
{ "count" : 41, "audit_logs" : [ { "instance_type" : "APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "action_name" : "DisabledIp", "instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "parent_instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "log_level" : "DEBUG INFO WARN", "input" : "input", "output" : "output", "error_msg" : "error_msg", "start_time" : "2021-01-30T23:00:00Z", "end_time" : "2021-01-31T23:00:00Z", "status" : "CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED", "trigger_type" : "DEBUG, TIMER, EVENT, MANUAL" } ] }
SDK Sample Code
The SDK sample code is as follows.
Query playbook instance review logs. Details - Instance type - APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG; Workflow ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Workflow name - DisabledIp; Instance ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Parent instance ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Log level - DEBUG, INFO WARN; Input - input; Output - output; Error message - error_msg. Start time - 2021-01-30 23:00:00;End time - 2021-01-31 23:00:00; Status - CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED Trigger type - DEBUG, TIMER, EVENT, or MANUAL.
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
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 ListPlaybookAuditLogsSolution { 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(); ListPlaybookAuditLogsRequest request = new ListPlaybookAuditLogsRequest(); request.withOffset(<offset>L); request.withLimit(<limit>L); request.withSortKey("<sort_key>"); request.withSortDir(ListPlaybookAuditLogsRequest.SortDirEnum.fromValue("<sort_dir>")); AuditLogInfo body = new AuditLogInfo(); body.withTriggerType("DEBUG, TIMER, EVENT, MANUAL"); body.withStatus("CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED"); body.withEndTime("2021-01-31T23:00:00Z"); body.withStartTime("2021-01-30T23:00:00Z"); body.withErrorMsg("error_msg"); body.withOutput("output"); body.withInput("input"); body.withLogLevel("DEBUG INFO WARN"); body.withParentInstanceId("909494e3-558e-46b6-a9eb-07a8e18ca62f"); body.withInstanceId("909494e3-558e-46b6-a9eb-07a8e18ca62f"); body.withActionName("DisabledIp"); body.withActionId("909494e3-558e-46b6-a9eb-07a8e18ca62f"); body.withInstanceType("APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG"); request.withBody(body); try { ListPlaybookAuditLogsResponse response = client.listPlaybookAuditLogs(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()); } } } |
Query playbook instance review logs. Details - Instance type - APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG; Workflow ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Workflow name - DisabledIp; Instance ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Parent instance ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Log level - DEBUG, INFO WARN; Input - input; Output - output; Error message - error_msg. Start time - 2021-01-30 23:00:00;End time - 2021-01-31 23:00:00; Status - CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED Trigger type - DEBUG, TIMER, EVENT, or MANUAL.
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 49 |
# 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 = ListPlaybookAuditLogsRequest() request.offset = <offset> request.limit = <limit> request.sort_key = "<sort_key>" request.sort_dir = "<sort_dir>" request.body = AuditLogInfo( trigger_type="DEBUG, TIMER, EVENT, MANUAL", status="CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED", end_time="2021-01-31T23:00:00Z", start_time="2021-01-30T23:00:00Z", error_msg="error_msg", output="output", input="input", log_level="DEBUG INFO WARN", parent_instance_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", instance_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", action_name="DisabledIp", action_id="909494e3-558e-46b6-a9eb-07a8e18ca62f", instance_type="APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG" ) response = client.list_playbook_audit_logs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Query playbook instance review logs. Details - Instance type - APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG; Workflow ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Workflow name - DisabledIp; Instance ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Parent instance ID - 909494e3-558e-46b6-a9eb-07a8e18ca62f; Log level - DEBUG, INFO WARN; Input - input; Output - output; Error message - error_msg. Start time - 2021-01-30 23:00:00;End time - 2021-01-31 23:00:00; Status - CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED Trigger type - DEBUG, TIMER, EVENT, or MANUAL.
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
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.ListPlaybookAuditLogsRequest{} request.Offset = int64(<offset>) request.Limit = int64(<limit>) sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest sortDirRequest:= model.GetListPlaybookAuditLogsRequestSortDirEnum().<SORT_DIR> request.SortDir = &sortDirRequest triggerTypeAuditLogInfo:= "DEBUG, TIMER, EVENT, MANUAL" statusAuditLogInfo:= "CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED" endTimeAuditLogInfo:= "2021-01-31T23:00:00Z" startTimeAuditLogInfo:= "2021-01-30T23:00:00Z" errorMsgAuditLogInfo:= "error_msg" outputAuditLogInfo:= "output" inputAuditLogInfo:= "input" logLevelAuditLogInfo:= "DEBUG INFO WARN" parentInstanceIdAuditLogInfo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f" instanceIdAuditLogInfo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f" actionNameAuditLogInfo:= "DisabledIp" actionIdAuditLogInfo:= "909494e3-558e-46b6-a9eb-07a8e18ca62f" instanceTypeAuditLogInfo:= "APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG" request.Body = &model.AuditLogInfo{ TriggerType: &triggerTypeAuditLogInfo, Status: &statusAuditLogInfo, EndTime: &endTimeAuditLogInfo, StartTime: &startTimeAuditLogInfo, ErrorMsg: &errorMsgAuditLogInfo, Output: &outputAuditLogInfo, Input: &inputAuditLogInfo, LogLevel: &logLevelAuditLogInfo, ParentInstanceId: &parentInstanceIdAuditLogInfo, InstanceId: &instanceIdAuditLogInfo, ActionName: &actionNameAuditLogInfo, ActionId: &actionIdAuditLogInfo, InstanceType: &instanceTypeAuditLogInfo, } response, err := client.ListPlaybookAuditLogs(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