更新时间:2025-08-30 GMT+08:00
分享

查询剧本实例审计日志

功能介绍

查询剧本实例审计日志

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/auditlogs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

分页查询参数,用于指定查询结果的起始位置,从0开始,limit 和 offset相加需要小于10000

limit

Long

分页查询参数,用于指定一次查询最多的结果数,从1开始,limit 和 offset相加需要小于10000

sort_key

String

参数解释:

排序字段

  • start_time 开始时间

  • end_time 结束时间

约束限制:

不涉及

取值范围:

  • start_time

  • end_time

默认取值:

sort_dir

String

sort_dir. asc, desc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

content-type

String

参数解释:

内容类型

  • application/json 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json

默认取值:

application/json

表4 请求Body参数

参数

是否必选

参数类型

描述

instance_type

String

实例类型(AOP_WORKFLOW--流程, SCRIPT--脚本, PLAYBOOK--剧本)

action_id

String

流程ID

action_name

String

流程名称

instance_id

String

实例ID

parent_instance_id

String

父节点实例ID

log_level

String

日志级别

input

String

输入

output

String

输出

error_msg

String

错误信息

start_time

String

开始时间

end_time

String

结束时间

status

String

状态。(RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止)

trigger_type

String

触发类型. TIMER--定时触发, EVENT--事件触发

响应参数

状态码:200

表5 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表6 响应Body参数

参数

参数类型

描述

count

Integer

总条数

audit_logs

Array of AuditLogInfo objects

审计日志列表信息

表7 AuditLogInfo

参数

参数类型

描述

instance_type

String

实例类型(AOP_WORKFLOW--流程, SCRIPT--脚本, PLAYBOOK--剧本)

action_id

String

流程ID

action_name

String

流程名称

instance_id

String

实例ID

parent_instance_id

String

父节点实例ID

log_level

String

日志级别

input

String

输入

output

String

输出

error_msg

String

错误信息

start_time

String

开始时间

end_time

String

结束时间

status

String

状态。(RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止)

trigger_type

String

触发类型. TIMER--定时触发, EVENT--事件触发

状态码:400

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

查询实例类型为APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG,动作id为909494e3-558e-46b6-a9eb-07a8e18ca62f,动作名称为DisabledIp,实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,父实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,日志等级为DEBUG INFO WARN,输入为input,输出为output,错误信息为error_msg,开始时间2021-01-30 23:00:00,结束时间2021-01-31 23:00:00,状态为CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED,触发类型为DEBUG, TIMER, EVENT, 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"
}

响应示例

状态码:200

请求成功响应信息

{
  "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代码示例

SDK代码示例如下。

Java

查询实例类型为APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG,动作id为909494e3-558e-46b6-a9eb-07a8e18ca62f,动作名称为DisabledIp,实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,父实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,日志等级为DEBUG INFO WARN,输入为input,输出为output,错误信息为error_msg,开始时间2021-01-30 23:00:00,结束时间2021-01-31 23:00:00,状态为CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED,触发类型为DEBUG, TIMER, EVENT, 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
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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ListPlaybookAuditLogsRequest request = new ListPlaybookAuditLogsRequest();
        request.withWorkspaceId("{workspace_id}");
        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());
        }
    }
}

Python

查询实例类型为APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG,动作id为909494e3-558e-46b6-a9eb-07a8e18ca62f,动作名称为DisabledIp,实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,父实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,日志等级为DEBUG INFO WARN,输入为input,输出为output,错误信息为error_msg,开始时间2021-01-30 23:00:00,结束时间2021-01-31 23:00:00,状态为CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED,触发类型为DEBUG, TIMER, EVENT, 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
# 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListPlaybookAuditLogsRequest()
        request.workspace_id = "{workspace_id}"
        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)

Go

查询实例类型为APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG,动作id为909494e3-558e-46b6-a9eb-07a8e18ca62f,动作名称为DisabledIp,实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,父实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f,日志等级为DEBUG INFO WARN,输入为input,输出为output,错误信息为error_msg,开始时间2021-01-30 23:00:00,结束时间2021-01-31 23:00:00,状态为CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED,触发类型为DEBUG, TIMER, EVENT, 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
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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPlaybookAuditLogsRequest{}
	request.WorkspaceId = "{workspace_id}"
	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)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功响应信息

400

请求失败响应信息

错误码

请参见错误码

相关文档