更新时间:2024-03-20 GMT+08:00
分享

查询剧本版本列表

功能介绍

查询剧本版本列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:32

最大长度:36

workspace_id

String

工作空间ID

最小长度:32

最大长度:36

playbook_id

String

剧本ID

最小长度:32

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

status

String

剧本版本状态,编辑中:EDITING 审核中:APPROVING 不通过:UNPASSED 已发布:PUBLISHED

最小长度:0

最大长度:64

enabled

Integer

启用/禁用

最小值:0

最大值:1

version_type

Integer

版本类型, 草稿版本:0 正式版本:1

最小值:0

最大值:10

offset

Integer

分页查询参数。用于指定查询结果的起始位置,从0开始

最小值:0

最大值:999999

limit

Integer

分页查询参数,用于指定一次查询最多的结果数,从1开始

最小值:1

最大值:999999

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

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

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

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

表5 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:1

最大长度:32

message

String

错误信息

最小长度:1

最大长度:32

size

Integer

分页查询数据大小

最小值:0

最大值:9999

page

Integer

当前页码

最小值:0

最大值:100

total

Integer

总数

最小值:0

最大值:99999

data

Array of PlaybookVersionListEntity objects

剧本版本列表信息

数组长度:0 - 100000000

表6 PlaybookVersionListEntity

参数

参数类型

描述

id

String

剧本版本ID

最小长度:32

最大长度:64

description

String

描述

最小长度:0

最大长度:1024

create_time

String

创建时间

最小长度:0

最大长度:64

update_time

String

更新时间

最小长度:0

最大长度:64

project_id

String

项目ID

最小长度:32

最大长度:64

creator_id

String

创建者ID

最小长度:32

最大长度:64

modifier_id

String

修改者ID

最小长度:32

最大长度:64

playbook_id

String

剧本ID

最小长度:32

最大长度:64

version

String

版本号

最小长度:32

最大长度:64

enabled

Boolean

是否激活

status

String

状态. (EDITING--编辑中, APPROVING--审核中, UNPASSED--审核不通过, PUBLISHED--审核通过)

最小长度:0

最大长度:64

action_strategy

String

执行策略. 目前仅支持异步并发执行,对应值为ASYNC

最小长度:0

最大长度:64

rule_enable

Boolean

过滤规则是否启用

dataclass_id

String

数据类ID

最小长度:0

最大长度:64

trigger_type

String

触发方式. EVENT--事件触发, TIMER--定时触发

最小长度:0

最大长度:64

dataobject_create

Boolean

标识数据对象是否创建时触发剧本

dataobject_update

Boolean

标识数据对象是否更新时触发剧本

dataobject_delete

Boolean

标识数据对象是否删除时触发剧本

version_type

Integer

版本类型

最小值:0

最大值:1

rule_id

String

过滤规则ID

最小长度:0

最大长度:64

dataclass_name

String

数据类名称

最小长度:0

最大长度:64

approve_name

String

审核者

最小长度:0

最大长度:64

状态码: 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

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

表8 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:0

最大长度:64

message

String

错误描述

最小长度:0

最大长度:1024

请求示例

响应示例

状态码: 200

请求成功响应信息

{
  "code" : 0,
  "message" : "Error message",
  "size" : 3,
  "page" : 10,
  "total" : 41,
  "data" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "description" : "This my XXXX",
    "create_time" : "2021-01-30T23:00:00Z+0800",
    "update_time" : "2021-01-30T23:00:00Z+0800",
    "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version" : "v1.1.1",
    "enabled" : true,
    "status" : "editing",
    "action_strategy" : "sync",
    "rule_enable" : true,
    "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "trigger_type" : "event",
    "dataobject_create" : true,
    "dataobject_update" : true,
    "dataobject_delete" : true,
    "version_type" : 1,
    "rule_id" : "string",
    "dataclass_name" : "string",
    "approve_name" : "string"
  } ]
}

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
49
50
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 ListPlaybookVersionsSolution {

    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();
        ListPlaybookVersionsRequest request = new ListPlaybookVersionsRequest();
        request.withStatus("<status>");
        request.withEnabled(<enabled>);
        request.withVersionType(<version_type>);
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        try {
            ListPlaybookVersionsResponse response = client.listPlaybookVersions(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
34
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListPlaybookVersionsRequest()
        request.status = "<status>"
        request.enabled = <enabled>
        request.version_type = <version_type>
        request.offset = <offset>
        request.limit = <limit>
        response = client.list_playbook_versions(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
39
40
41
42
43
44
45
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.ListPlaybookVersionsRequest{}
	statusRequest:= "<status>"
	request.Status = &statusRequest
	enabledRequest:= int32(<enabled>)
	request.Enabled = &enabledRequest
	versionTypeRequest:= int32(<version_type>)
	request.VersionType = &versionTypeRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	response, err := client.ListPlaybookVersions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求成功响应信息

400

请求失败响应信息

错误码

请参见错误码

分享:

    相关文档

    相关产品