Creating a Trigger
Function
Create a trigger.
Constraints
None
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
swr:repo:createTrigger
Write
repo *
-
-
-
URI
POST /v2/manage/namespaces/{namespace}/repos/{repository}/triggers
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| namespace | Yes | String | Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. |
| repository | Yes | String | Image repository name. The name contains 1 to 128 characters, starting and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. If the parameter value contains a slash (/), replace it with a dollar sign ($) before sending the request. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Message body type (format). Possible values: application/json;charset=utf-8 application/json |
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| action | Yes | String | Action to trigger. The value is update. |
| app_type | Yes | String | Workload type. Options: |
| application | Yes | String | App name |
| cluster_id | No | String | Cluster ID. If trigger_mode is set to cci, leave this parameter blank. |
| cluster_name | No | String | Cluster name. If trigger_mode is set to cci, leave this parameter blank. |
| cluster_ns | Yes | String | Namespace where the application is located. |
| condition | Yes | String | Trigger condition. If type is set to all, the value is .*. If type is set to tag, the value is a tag name. If type is set to regular, the value is a regular expression. |
| container | No | String | Name of the container to be updated. By default, all containers using this image are updated. |
| enable | Yes | String | Valid or not |
| name | Yes | String | Trigger name |
| trigger_mode | No | String | Trigger type. The value can be cce or cci. The default value is cce. |
| trigger_type | Yes | String | Triggering condition. Options: |
Response Parameters
Status code: 201
None
Example Requests
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"
} Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 201 | The creation succeeded. |
| 400 | A request error occurred. |
| 401 | Authentication failed. |
| 404 | The organization or the repository does not exist. |
| 409 | The trigger already exists. |
| 500 | An internal error occurred. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot