更新时间:2024-10-22 GMT+08:00
分享

查询剧本列表

功能介绍

查询剧本列表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:32

最大长度:36

workspace_id

String

工作空间ID

最小长度:32

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

search_txt

String

搜索关键字

最小长度:32

最大长度:36

enabled

Boolean

是否启用

offset

Integer

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

最小值:0

最大值:999999

缺省值:0

limit

Integer

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

最小值:1

最大值:999999

description

String

剧本描述

最小长度:0

最大长度:64

dataclass_name

String

数据类名称

最小长度:0

最大长度:64

name

String

剧本名称

最小长度:0

最大长度:64

请求参数

表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

total

Integer

总条数

最小值:0

最大值:99999

size

Integer

分页查询数据大小

最小值:0

最大值:9999

page

Integer

当前页码

最小值:0

最大值:100

data

Array of PlaybookInfo objects

剧本列表信息

数组长度:0 - 100000000

表6 PlaybookInfo

参数

参数类型

描述

id

String

剧本ID

最小长度:32

最大长度:64

name

String

剧本名称

最小长度:0

最大长度:1024

description

String

描述信息

最小长度:0

最大长度:1024

create_time

String

剧本创建时间

最小长度:0

最大长度:64

update_time

String

剧本更新时间

最小长度:0

最大长度:64

project_id

String

项目ID

最小长度:32

最大长度:64

version_id

String

剧本版本ID

最小长度:32

最大长度:64

enabled

Boolean

是否启用

workspace_id

String

工作空间ID

最小长度:32

最大长度:64

approve_role

String

审核用户角色

最小长度:0

最大长度:64

user_role

String

用户角色

最小长度:0

最大长度:64

edit_role

String

编辑用户角色

最小长度:0

最大长度:64

owner_id

String

所有者ID

最小长度:32

最大长度:64

version

String

版本号

最小长度:32

最大长度:64

dataclass_name

String

数据类名称

最小长度:0

最大长度:64

dataclass_id

String

数据类ID

最小长度:1

最大长度:64

unaudited_version_id

String

待审核剧本版本ID

最小长度:1

最大长度:64

reject_version_id

String

已驳回剧本版本ID

最小长度:1

最大长度: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" : null,
  "total" : 41,
  "page" : 10,
  "data" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "MyXXX",
    "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",
    "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "enabled" : true,
    "workspace_id" : "string",
    "approve_role" : "approve",
    "user_role" : "string",
    "edit_role" : "editor",
    "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version" : "v1.1.1",
    "dataclass_name" : "string",
    "dataclass_id" : "string",
    "unaudited_version_id" : "string",
    "reject_version_id" : "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
51
52
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 ListPlaybooksSolution {

    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();
        ListPlaybooksRequest request = new ListPlaybooksRequest();
        request.withSearchTxt("<search_txt>");
        request.withEnabled(<enabled>);
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withDescription("<description>");
        request.withDataclassName("<dataclass_name>");
        request.withName("<name>");
        try {
            ListPlaybooksResponse response = client.listPlaybooks(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
35
36
37
# 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 = ListPlaybooksRequest()
        request.search_txt = "<search_txt>"
        request.enabled = <Enabled>
        request.offset = <offset>
        request.limit = <limit>
        request.description = "<description>"
        request.dataclass_name = "<dataclass_name>"
        request.name = "<name>"
        response = client.list_playbooks(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
46
47
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.ListPlaybooksRequest{}
	searchTxtRequest:= "<search_txt>"
	request.SearchTxt = &searchTxtRequest
	enabledRequest:= <enabled>
	request.Enabled = &enabledRequest
	request.Offset = int32(<offset>)
	request.Limit = int32(<limit>)
	descriptionRequest:= "<description>"
	request.Description = &descriptionRequest
	dataclassNameRequest:= "<dataclass_name>"
	request.DataclassName = &dataclassNameRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	response, err := client.ListPlaybooks(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

剧本列表查询成功响应参数

400

查询失败响应参数

错误码

请参见错误码

相关文档