查询流程列表
功能介绍
查询流程列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/workflows
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id 最小长度:32 最大长度:36 |
workspace_id |
是 |
String |
工作空间id 最小长度:32 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量 最小值:0 最大值:999999999 缺省值:0 |
limit |
否 |
Integer |
数据量 最小值:1 最大值:100 缺省值:10 |
order |
否 |
String |
排序顺序,asc:升序,desc:降序 最小长度:0 最大长度:4 枚举值:
|
sortby |
否 |
String |
排序字段,create_time:创建时间,category:类型分类名称 最小长度:2 最大长度:32 枚举值:
|
enabled |
否 |
Boolean |
是否启用 |
last_version |
否 |
Boolean |
最新版本号 |
name |
否 |
String |
流程名称 最小长度:1 最大长度:64 |
description |
否 |
String |
流程描述 最小长度:1 最大长度:512 |
dataclass_id |
否 |
String |
数据类ID 最小长度:1 最大长度:64 |
dataclass_name |
否 |
String |
数据类名称 最小长度:1 最大长度:64 |
aop_type |
否 |
String |
流程类型 最小长度:1 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:0 最大长度:2097152 |
content-type |
是 |
String |
内容类型 缺省值:application/json;charset=UTF-8 最小长度:0 最大长度:64 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
返回码 最小长度:0 最大长度:1000 |
total |
Integer |
数据总条数 最小值:0 最大值:1000 |
offset |
Integer |
当前页大小 最小值:0 最大值:1000 |
limit |
Integer |
当前页码 最小值:0 最大值:1000 |
message |
String |
请求ID 最小长度:32 最大长度:36 |
success |
Boolean |
是否成功 |
data |
Array of AopWorkflowInfo objects |
流程信息列表 数组长度:0 - 100 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
流程ID 最小长度:32 最大长度:64 |
name |
String |
流程名称 最小长度:0 最大长度:1024 |
description |
String |
描述 最小长度:0 最大长度:1024 |
project_id |
String |
租户ID 最小长度:32 最大长度:64 |
owner_id |
String |
所有者ID 最小长度:32 最大长度:64 |
creator_id |
String |
创建者ID 最小长度:32 最大长度:64 |
edit_role |
String |
编辑角色 最小长度:32 最大长度:64 |
use_role |
String |
是用角色 最小长度:32 最大长度:64 |
approve_role |
String |
审核人 最小长度:32 最大长度:64 |
enabled |
Boolean |
是否已启用 |
workspace_id |
String |
工作空间ID 最小长度:32 最大长度:64 |
version_id |
String |
流程版本ID 最小长度:32 最大长度:64 |
current_approval_version_id |
String |
当前待审核版本号 最小长度:1 最大长度:64 |
current_rejected_versoin_id |
String |
当前拒绝的版本号 最小长度:1 最大长度:64 |
aop_type |
String |
aop的类型有以下的值 NORMAL, 通用 SURVEY, 调查 HEMOSTASIS,止血 EASE;缓解 最小长度:1 最大长度:64 |
engine_type |
String |
引擎的类型分为共享版和专项版 最小长度:1 最大长度:64 |
dataclass_id |
String |
数据类的ID 最小长度:1 最大长度:64 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 最小长度:0 最大长度:64 |
message |
String |
错误描述 最小长度:0 最大长度:1024 |
请求示例
查询流程列表,偏移量为10,查询3条
{ "limit" : 3, "offset" : 10 }
响应示例
状态码: 200
请求成功
{ "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "total" : 41, "limit" : 2, "offset" : 1, "success" : true, "data" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "流程名称", "description" : "描述", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "edit_role" : "编辑者", "use_role" : "使用者", "approve_role" : "审批者", "enabled" : true, "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "current_approval_version_id" : "v2", "current_rejected_versoin_id" : "v1", "aop_type" : "EASE;缓解", "engine_type" : "public_engine", "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" } ] }
SDK代码示例
SDK代码示例如下。
查询流程列表,偏移量为10,查询3条
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 |
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 ListWorkflowsSolution { 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(); ListWorkflowsRequest request = new ListWorkflowsRequest(); request.withEnabled(<enabled>); request.withLastVersion(<last_version>); request.withName("<name>"); request.withDescription("<description>"); request.withDataclassId("<dataclass_id>"); request.withDataclassName("<dataclass_name>"); request.withAopType("<aop_type>"); request.withOffset(<offset>); request.withLimit(<limit>); request.withOrder(ListWorkflowsRequest.OrderEnum.fromValue("<order>")); request.withSortby(ListWorkflowsRequest.SortbyEnum.fromValue("<sortby>")); try { ListWorkflowsResponse response = client.listWorkflows(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()); } } } |
查询流程列表,偏移量为10,查询3条
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 |
# 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 = ListWorkflowsRequest() request.enabled = <Enabled> request.last_version = <LastVersion> request.name = "<name>" request.description = "<description>" request.dataclass_id = "<dataclass_id>" request.dataclass_name = "<dataclass_name>" request.aop_type = "<aop_type>" request.offset = <offset> request.limit = <limit> request.order = "<order>" request.sortby = "<sortby>" response = client.list_workflows(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
查询流程列表,偏移量为10,查询3条
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 |
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.ListWorkflowsRequest{} enabledRequest:= <enabled> request.Enabled = &enabledRequest lastVersionRequest:= <last_version> request.LastVersion = &lastVersionRequest nameRequest:= "<name>" request.Name = &nameRequest descriptionRequest:= "<description>" request.Description = &descriptionRequest dataclassIdRequest:= "<dataclass_id>" request.DataclassId = &dataclassIdRequest dataclassNameRequest:= "<dataclass_name>" request.DataclassName = &dataclassNameRequest aopTypeRequest:= "<aop_type>" request.AopType = &aopTypeRequest offsetRequest:= float32(<offset>) request.Offset = &offsetRequest limitRequest:= float32(<limit>) request.Limit = &limitRequest orderRequest:= model.GetListWorkflowsRequestOrderEnum().<ORDER> request.Order = &orderRequest sortbyRequest:= model.GetListWorkflowsRequestSortbyEnum().<SORTBY> request.Sortby = &sortbyRequest response, err := client.ListWorkflows(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
查询数据类列表错误返回body体 |
错误码
请参见错误码。