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
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. Enter 1 to 128 characters. It must start and end 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. Replace a slash (/) with a dollar sign ($) before you send the request. |
Request 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. Default value: 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. |
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
None
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
Status Codes
Status Code |
Description |
---|---|
201 |
Creation succeeded. |
400 |
Request error. |
401 |
Authentication failed. |
404 |
The organization or repository was not found. |
409 |
The trigger already exists. |
500 |
Internal error. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.