创建触发器 - CreateTrigger
功能介绍
创建触发器
接口约束
无
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/manage/namespaces/{namespace}/repos/{repository}/triggers
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| namespace | 是 | String | 参数解释: 组织名称。用于唯一标识一个组织,组织下的所有镜像仓库都属于该组织。 约束限制: 不涉及。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 默认取值: 不涉及。 |
| repository | 是 | String | 参数解释: 镜像仓库名称过滤关键字,用于模糊匹配镜像仓库列表。与精确匹配的name参数不同,filter支持模糊查询。 约束限制: 不涉及。 取值范围: 小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),用于指定请求体的MIME类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token。用于调用API时的鉴权。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| action | 是 | String | 参数解释: 触发动作。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| app_type | 是 | String | 参数解释: 应用类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| application | 是 | String | 参数解释: 应用名。 约束限制: 不涉及。 取值范围: 长度1~255个字符,以字母或数字开头,后面可跟字母、数字、小数点、中划线或下划线。 默认取值: 不涉及。 |
| cluster_id | 否 | String | 参数解释: 集群ID(trigger_mode设置为cci时为空)。可通过CCE服务获取集群列表接口查询。 约束限制: trigger_mode为cci时为空。 取值范围: 由字母、数字组成,长度1~65个字符。 默认取值: 不涉及。 |
| cluster_name | 否 | String | 参数解释: 集群名(trigger_mode设置为cci时为空)。 约束限制: trigger_mode为cci时为空。 取值范围: 以小写字母开头,后面跟小写字母、数字或中划线,以小写字母或数字结尾,长度3~128个字符,符合正则^[a-z][a-z0-9-]{2,126}[a-z0-9]$。 默认取值: 不涉及。 |
| cluster_ns | 是 | String | 参数解释: 应用名所在的namespace。 约束限制: 不涉及。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~255个字符。 默认取值: 不涉及。 |
| condition | 是 | String | 参数解释: 触发条件。根据trigger_type的值不同,condition的取值不同。 约束限制: 必须是有效的正则表达式。取值与trigger_type相关。 取值范围: 默认取值: 不涉及。 |
| container | 否 | String | 参数解释: 需更新的container名,默认为所有container。 约束限制: 为空时表示更新所有container。 取值范围: 由小写字母、数字、小数点、下划线、中划线、斜杠组成,长度1~255个字符。 默认取值: 空(表示更新所有container)。 |
| enable | 是 | String | 参数解释: 是否生效。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| name | 是 | String | 参数解释: 触发器名称。 约束限制: 不涉及。 取值范围: 长度1~64个字符,以字母开头,后面可跟字母、数字、中划线或下划线,符合正则^[a-zA-Z]+((-|_)?[a-zA-Z0-9]+)*$。 默认取值: 不涉及。 |
| trigger_mode | 否 | String | 参数解释: 触发器模式。 约束限制: 不涉及。 取值范围: 默认取值: cce |
| trigger_type | 是 | String | 参数解释: 触发类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
响应参数
状态码:201
无
请求示例
POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/triggers
{
"action" : "update",
"app_type" : "deployments",
"application" : "adsfa",
"cluster_id" : "5b28c12f-dc10-11e9-97b3-0255ac1001b5",
"cluster_name" : "test",
"cluster_ns" : "default",
"condition" : ".*",
"container" : "",
"enable" : "true",
"name" : "test",
"trigger_mode" : "cce",
"trigger_type" : "all"
} 响应示例
无
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 | 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.*; public class CreateTriggerSolution { 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); SwrClient client = SwrClient.newBuilder() .withCredential(auth) .withRegion(SwrRegion.valueOf("<YOUR REGION>")) .build(); CreateTriggerRequest request = new CreateTriggerRequest(); request.withNamespace("{namespace}"); request.withRepository("{repository}"); CreateTriggerRequestBody body = new CreateTriggerRequestBody(); body.withTriggerType("all"); body.withTriggerMode("cce"); body.withName("test"); body.withEnable("true"); body.withContainer(""); body.withCondition(".*"); body.withClusterNs("default"); body.withClusterName("test"); body.withClusterId("5b28c12f-dc10-11e9-97b3-0255ac1001b5"); body.withApplication("adsfa"); body.withAppType("deployments"); body.withAction("update"); request.withBody(body); try { CreateTriggerResponse response = client.createTrigger(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 | # 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"] credentials = BasicCredentials(ak, sk) client = SwrClient.new_builder() \ .with_credentials(credentials) \ .with_region(SwrRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateTriggerRequest() request.namespace = "{namespace}" request.repository = "{repository}" request.body = CreateTriggerRequestBody( trigger_type="all", trigger_mode="cce", name="test", enable="true", container="", condition=".*", cluster_ns="default", cluster_name="test", cluster_id="5b28c12f-dc10-11e9-97b3-0255ac1001b5", application="adsfa", app_type="deployments", action="update" ) response = client.create_trigger(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 | 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") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := swr.SwrClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := swr.NewSwrClient(hcClient) request := &model.CreateTriggerRequest{} request.Namespace = "{namespace}" request.Repository = "{repository}" triggerModeCreateTriggerRequestBody:= "cce" containerCreateTriggerRequestBody:= "" clusterNameCreateTriggerRequestBody:= "test" clusterIdCreateTriggerRequestBody:= "5b28c12f-dc10-11e9-97b3-0255ac1001b5" request.Body = &model.CreateTriggerRequestBody{ TriggerType: "all", TriggerMode: &triggerModeCreateTriggerRequestBody, Name: "test", Enable: "true", Container: &containerCreateTriggerRequestBody, Condition: ".*", ClusterNs: "default", ClusterName: &clusterNameCreateTriggerRequestBody, ClusterId: &clusterIdCreateTriggerRequestBody, Application: "adsfa", AppType: "deployments", Action: "update", } response, err := client.CreateTrigger(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 201 | 创建成功 |
| 400 | 错误的请求 |
| 401 | 鉴权失败 |
| 404 | 组织或镜像仓库不存在 |
| 409 | 触发器已存在 |
| 500 | 内部错误 |
错误码
请参见错误码。