Updated on 2024-02-23 GMT+08:00

Creating a Trigger

Description

Create a trigger.

Constraints

None

API Calling

For details, see Calling APIs.

URI

POST /v2/manage/namespaces/{namespace}/repos/{repository}/triggers

Table 1 Path parameters

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). The value can be application/json;charset=utf-8 application/json

The default value is application/json.

X-Auth-Token

Yes

String

User token.

The token 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Action to trigger. The value is update.

app_type

Yes

String

Application type. The value can be deployments or statefulsets.

application

Yes

String

Application name.

cluster_id

No

String

Cluster ID. When trigger_mode is set to cci, leave this parameter blank.

cluster_name

No

String

Cluster name. When 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

Whether to enable the trigger.

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

Trigger condition. The value can be all, tag, or regular.

Response Parameters

N/A

Example Request

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 Response

None

SDK Sample Code

The following are SDK sample code:

 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
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("cn-north-4"))
                .build();
        CreateTriggerRequest request = new CreateTriggerRequest();
        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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = SwrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SwrRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CreateTriggerRequest()
        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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := swr.NewSwrClient(
        swr.SwrClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CreateTriggerRequest{}
	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 in other programming languages, see the Sample Code tab in the API Explorer.

Status Codes

Status Code

Description

201

Creation succeeded.

400

Request error.

401

Authentication failed.

404

The organization or the repository does not exist.

409

The trigger already exists.

500

Internal error.

Error Codes

For details, see Error Codes.