创建触发器
功能介绍
创建触发器
接口约束
无
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/webhook/policies
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
instance_id |
是 |
String |
企业仓库实例ID |
namespace_name |
是 |
String |
命名空间名称 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
触发器名称,由字母、汉字、数字、下划线(_)、中划线 (-)组成,1-256个字符。 |
description |
否 |
String |
触发器描述 |
targets |
是 |
Array of Target objects |
触发器目标参数 |
scope_rules |
是 |
Array of ScopeRule objects |
作用范围规则 |
event_types |
是 |
Array of strings |
触发器触发条件,当前支持PUSH_ARTIFACT |
enabled |
是 |
Boolean |
是否启用 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
触发类型,可选http |
address |
是 |
String |
触发地址,不可修改 |
auth_header |
否 |
String |
请求头,格式为key1:value1;key2:value2 |
skip_cert_verify |
否 |
Boolean |
是否跳过证书认证 |
address_type |
是 |
String |
触发地址类型,可选internal(内网),internet(公网)。internal必须为内网ip形式。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
tag_selectors |
是 |
Array of RuleSelector objects |
制品版本选择器,目前只支持长度为1 |
scope_selectors |
是 |
Map<String,Array<RuleSelector>> |
制品仓库选择器,目前只支持repository且长度为1 |
repo_scope_mode |
是 |
String |
repository选择方式。可选regular、selection,前端显示需要,api调用时可选regular |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
触发器ID |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/webhook/policies { "name" : "mywebhook", "description" : "my describe", "targets" : [ { "type" : "http", "address" : "https://100.0.0.1:80", "auth_header" : "param1:value1", "skip_cert_verify" : false, "address_type" : "internal" } ], "scope_rules" : [ { "tag_selectors" : [ { "kind" : "doublestar", "decoration" : "matches", "pattern" : "**" } ], "scope_selectors" : { "repository" : [ { "kind" : "doublestar", "decoration" : "repoMatches", "pattern" : "{myrepo}" } ] }, "repo_scope_mode" : "selection" } ], "event_types" : [ "PUSH_ARTIFACT" ], "enabled" : true }
响应示例
状态码:201
创建触发器成功
{ "id" : 34 }
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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
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.swr.v2.region.SwrRegion; import com.huaweicloud.sdk.swr.v2.*; import com.huaweicloud.sdk.swr.v2.model.*; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.util.HashMap; public class CreateInstanceWebhookSolution { 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); SwrClient client = SwrClient.newBuilder() .withCredential(auth) .withRegion(SwrRegion.valueOf("<YOUR REGION>")) .build(); CreateInstanceWebhookRequest request = new CreateInstanceWebhookRequest(); request.withInstanceId("{instance_id}"); request.withNamespaceName("{namespace_name}"); CreateWebhookPolicyRequestBody body = new CreateWebhookPolicyRequestBody(); List<String> listbodyEventTypes = new ArrayList<>(); listbodyEventTypes.add("PUSH_ARTIFACT"); List<RuleSelector> listScopeSelectorsScopeSelectors = new ArrayList<>(); listScopeSelectorsScopeSelectors.add( new RuleSelector() .withKind("doublestar") .withDecoration("repoMatches") .withPattern("{myrepo}") ); Map<String, List<RuleSelector>> listScopeRulesScopeSelectors = new HashMap<>(); listScopeRulesScopeSelectors.put("repository", listScopeSelectorsScopeSelectors); List<RuleSelector> listScopeRulesTagSelectors = new ArrayList<>(); listScopeRulesTagSelectors.add( new RuleSelector() .withKind("doublestar") .withDecoration("matches") .withPattern("**") ); List<ScopeRule> listbodyScopeRules = new ArrayList<>(); listbodyScopeRules.add( new ScopeRule() .withTagSelectors(listScopeRulesTagSelectors) .withScopeSelectors(listScopeRulesScopeSelectors) .withRepoScopeMode("selection") ); List<Target> listbodyTargets = new ArrayList<>(); listbodyTargets.add( new Target() .withType("http") .withAddress("https://100.0.0.1:80") .withAuthHeader("param1:value1") .withSkipCertVerify(false) .withAddressType("internal") ); body.withEnabled(true); body.withEventTypes(listbodyEventTypes); body.withScopeRules(listbodyScopeRules); body.withTargets(listbodyTargets); body.withDescription("my describe"); body.withName("mywebhook"); request.withBody(body); try { CreateInstanceWebhookResponse response = client.createInstanceWebhook(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 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 70 71 72 73 74 75 76 77 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkswr.v2.region.swr_region import SwrRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkswr.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 = SwrClient.new_builder() \ .with_credentials(credentials) \ .with_region(SwrRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateInstanceWebhookRequest() request.instance_id = "{instance_id}" request.namespace_name = "{namespace_name}" listEventTypesbody = [ "PUSH_ARTIFACT" ] listScopeSelectorsScopeSelectors = [ RuleSelector( kind="doublestar", decoration="repoMatches", pattern="{myrepo}" ) ] listScopeSelectorsScopeRules = { "repository": listScopeSelectorsScopeSelectors } listTagSelectorsScopeRules = [ RuleSelector( kind="doublestar", decoration="matches", pattern="**" ) ] listScopeRulesbody = [ ScopeRule( tag_selectors=listTagSelectorsScopeRules, scope_selectors=listScopeSelectorsScopeRules, repo_scope_mode="selection" ) ] listTargetsbody = [ Target( type="http", address="https://100.0.0.1:80", auth_header="param1:value1", skip_cert_verify=False, address_type="internal" ) ] request.body = CreateWebhookPolicyRequestBody( enabled=True, event_types=listEventTypesbody, scope_rules=listScopeRulesbody, targets=listTargetsbody, description="my describe", name="mywebhook" ) response = client.create_instance_webhook(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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/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 := swr.NewSwrClient( swr.SwrClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateInstanceWebhookRequest{} request.InstanceId = "{instance_id}" request.NamespaceName = "{namespace_name}" var listEventTypesbody = []string{ "PUSH_ARTIFACT", } var listScopeSelectorsScopeSelectors = []model.RuleSelector{ { Kind: "doublestar", Decoration: "repoMatches", Pattern: "{myrepo}", }, } var listScopeSelectorsScopeRules = map[string][](model.RuleSelector){ "repository": listScopeSelectorsScopeSelectors, } var listTagSelectorsScopeRules = []model.RuleSelector{ { Kind: "doublestar", Decoration: "matches", Pattern: "**", }, } var listScopeRulesbody = []model.ScopeRule{ { TagSelectors: listTagSelectorsScopeRules, ScopeSelectors: listScopeSelectorsScopeRules, RepoScopeMode: "selection", }, } authHeaderTargets:= "param1:value1" skipCertVerifyTargets:= false var listTargetsbody = []model.Target{ { Type: "http", Address: "https://100.0.0.1:80", AuthHeader: &authHeaderTargets, SkipCertVerify: &skipCertVerifyTargets, AddressType: "internal", }, } descriptionCreateWebhookPolicyRequestBody:= "my describe" request.Body = &model.CreateWebhookPolicyRequestBody{ Enabled: true, EventTypes: listEventTypesbody, ScopeRules: listScopeRulesbody, Targets: listTargetsbody, Description: &descriptionCreateWebhookPolicyRequestBody, Name: "mywebhook", } response, err := client.CreateInstanceWebhook(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
创建触发器成功 |
400 |
错误的请求 |
401 |
鉴权失败 |
403 |
禁止访问 |
404 |
未找到资源 |
500 |
内部错误 |
错误码
请参见错误码。