创建剧本规则
功能介绍
创建剧本规则
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
workspace_id |
是 |
String |
工作空间ID |
version_id |
是 |
String |
剧本版本ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
content-type |
是 |
String |
application/json;charset=UTF-8 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
rule |
是 |
ConditionInfo object |
剧本触发规则详情 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
expression_type |
否 |
String |
表达式类型。默认为common,事件触发剧本必填 |
conditions |
否 |
Array of ConditionItem objects |
触发条件。事件触发剧本必填 |
logics |
否 |
Array of strings |
条件逻辑组合。事件触发剧本必填 |
cron |
否 |
String |
Cron 表达式(定时任务)。定时触发剧本必填 |
schedule_type |
否 |
String |
定时重复类型(second--秒, hour--小时,day--天,week-周)。定时触发剧本必填 |
start_type |
否 |
String |
剧本开始执行类型,IMMEDIATELY--创建完成立即执行, CUSTOM--自定义执行时间。定时触发剧本必填 |
end_type |
否 |
String |
剧本结束执行类型,FOREVER--一直执行, CUSTOM--自定义结束时间。定时触发剧本必填 |
end_time |
否 |
String |
定时结束时间。定时触发剧本必填 |
repeat_range |
否 |
String |
执行时间段 2021-01-30T23:00:00Z+0800。定时触发剧本必填 |
only_once |
否 |
Boolean |
是否只执行一次。定时触发剧本必填 |
execution_type |
否 |
String |
执行队列类型(PARALLEL-新任务与之前任务并行)。定时触发剧本必填 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 |
message |
String |
错误信息 |
data |
RuleInfo object |
剧本触发规格信息 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 |
message |
String |
错误描述 |
请求示例
创建一条剧本规则,名称为condition_0,表达式类型为所有,
{ "rule" : { "expression_type" : "common", "conditions" : [ { "name" : "condition_0", "detail" : "123", "data" : [ "handle_status, ==, Open" ] } ], "logics" : [ "condition_0" ] } }
响应示例
状态码: 200
请求成功响应信息
{ "code" : 0, "message" : "", "data" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "rule" : "{\"expression_type\":\"common\",\"conditions\":[{\"name\":\"condition_0\",\"data\":[\"ref_order_id\",\"==\",\"123\"],\"detail\":\"123\"}],\"logics\":[\"condition_0\"]}" } }
SDK代码示例
SDK代码示例如下。
Java
创建一条剧本规则,名称为condition_0,表达式类型为所有,
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 67 68 69 |
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.*; import java.util.List; import java.util.ArrayList; public class CreatePlaybookRuleSolution { 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(); CreatePlaybookRuleRequest request = new CreatePlaybookRuleRequest(); request.withWorkspaceId("{workspace_id}"); request.withVersionId("{version_id}"); CreateRuleInfo body = new CreateRuleInfo(); List<String> listRuleLogics = new ArrayList<>(); listRuleLogics.add("condition_0"); List<String> listConditionsData = new ArrayList<>(); listConditionsData.add("handle_status, ==, Open"); List<ConditionItem> listRuleConditions = new ArrayList<>(); listRuleConditions.add( new ConditionItem() .withName("condition_0") .withDetail("123") .withData(listConditionsData) ); ConditionInfo rulebody = new ConditionInfo(); rulebody.withExpressionType("common") .withConditions(listRuleConditions) .withLogics(listRuleLogics); body.withRule(rulebody); request.withBody(body); try { CreatePlaybookRuleResponse response = client.createPlaybookRule(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
创建一条剧本规则,名称为condition_0,表达式类型为所有,
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 |
# 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 = CreatePlaybookRuleRequest() request.workspace_id = "{workspace_id}" request.version_id = "{version_id}" listLogicsRule = [ "condition_0" ] listDataConditions = [ "handle_status, ==, Open" ] listConditionsRule = [ ConditionItem( name="condition_0", detail="123", data=listDataConditions ) ] rulebody = ConditionInfo( expression_type="common", conditions=listConditionsRule, logics=listLogicsRule ) request.body = CreateRuleInfo( rule=rulebody ) response = client.create_playbook_rule(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
创建一条剧本规则,名称为condition_0,表达式类型为所有,
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 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.CreatePlaybookRuleRequest{} request.WorkspaceId = "{workspace_id}" request.VersionId = "{version_id}" var listLogicsRule = []string{ "condition_0", } var listDataConditions = []string{ "handle_status, ==, Open", } nameConditions:= "condition_0" detailConditions:= "123" var listConditionsRule = []model.ConditionItem{ { Name: &nameConditions, Detail: &detailConditions, Data: &listDataConditions, }, } expressionTypeRule:= "common" rulebody := &model.ConditionInfo{ ExpressionType: &expressionTypeRule, Conditions: &listConditionsRule, Logics: &listLogicsRule, } request.Body = &model.CreateRuleInfo{ Rule: rulebody, } response, err := client.CreatePlaybookRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功响应信息 |
400 |
请求失败响应信息 |
错误码
请参见错误码。