# 查询剧本版本列表 - ListPlaybookVersions #### 功能介绍 查询剧本版本列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | | workspace_id | 是 | String | 工作空间ID | | playbook_id | 是 | String | 剧本ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | status | 否 | String | 剧本版本状态，编辑中：EDITING 审核中：APPROVING 不通过：UNPASSED 已发布：PUBLISHED | | enabled | 否 | Integer | 启用/禁用 | | version_type | 否 | Integer | 版本类型， 草稿版本：0 正式版本：1 | | offset | 否 | Integer | 分页查询参数。用于指定查询结果的起始位置，从0开始 | | limit | 否 | Integer | 分页查询参数，用于指定一次查询最多的结果数，从1开始 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json **默认取值：** application/json | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码 | | message | String | 错误信息 | | size | Integer | 分页查询数据大小 | | page | Integer | 当前页码 | | total | Integer | 总数 | | data | Array of [PlaybookVersionListEntity] objects | 剧本版本列表信息 | 表6PlaybookVersionListEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 剧本版本ID | | description | String | 描述 | | create_time | String | 创建时间 | | update_time | String | 更新时间 | | project_id | String | 项目ID | | creator_id | String | 创建者ID | | modifier_id | String | 修改者ID | | playbook_id | String | 剧本ID | | version | String | 版本号 | | enabled | Boolean | 是否激活 | | status | String | 状态. (EDITING--编辑中, APPROVING--审核中, UNPASSED--审核不通过, PUBLISHED--审核通过) | | action_strategy | String | 执行策略. 目前仅支持异步并发执行，对应值为ASYNC | | rule_enable | Boolean | 过滤规则是否启用 | | dataclass_id | String | 数据类ID | | trigger_type | String | 触发方式. EVENT--事件触发, TIMER--定时触发 | | dataobject_create | Boolean | 标识数据对象是否创建时触发剧本 | | dataobject_update | Boolean | 标识数据对象是否更新时触发剧本 | | dataobject_delete | Boolean | 标识数据对象是否删除时触发剧本 | | version_type | Integer | **参数解释：** 版本类型 - 0 草稿版本 - 1 正式版本 **约束限制：** 不涉及 **取值范围：** - 0 - 1 **默认取值：** 0 | | rule_id | String | 过滤规则ID | | dataclass_name | String | 数据类名称 | | approve_name | String | 审核者 | **状态码：400** 表7响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID,格式为：request_uuid-timestamp-hostname | 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **取值范围**: 不涉及 | | message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** 请求成功响应信息 ``` { "code" : 0, "message" : "success", "size" : 3, "page" : 10, "total" : 41, "data" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "description" : "This is a description.", "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代码示例如下。 - [Java] ``` 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.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("")) .build(); ListPlaybookVersionsRequest request = new ListPlaybookVersionsRequest(); request.withWorkspaceId("{workspace_id}"); request.withPlaybookId("{playbook_id}"); 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()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 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("")) \ .build() try: request = ListPlaybookVersionsRequest() request.workspace_id = "{workspace_id}" request.playbook_id = "{playbook_id}" 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) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ListPlaybookVersionsRequest{} request.WorkspaceId = "{workspace_id}" request.PlaybookId = "{playbook_id}" response, err := client.ListPlaybookVersions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ListPlaybookVersions&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功响应信息 | | 400 | 请求失败响应信息 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。