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

Creating a Trigger

Function

Create a trigger.

URI

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

Table 1 describes the parameters.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

namespace

Yes

String

Organization name

repository

Yes

String

Image repository name

Request

  • 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 or 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 an IAM API. The value of X-Subject-Token in the response header is the user token.

    Table 3 Request body parameter description

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

    • When trigger_type is set to all, set this parameter to .*.
    • When trigger_type is set to tag, set this parameter to specific image tags separated by semicolons (;).
    • When trigger_type is set to regular, set this parameter to 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 (all tags), tag (specific tag), or regular (tags matching regular expression).

  • Example request
    POST https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/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"
    }

Response

  • Response parameters

    N/A

  • Example response

    N/A

Status Code

Status Code

Description

201

Creation successful.

400

Request error.

401

Authentication failed.

404

The organization does not exist.

500

Failed to complete the request because of an internal service error.

Error Codes

For details, see Error Codes.