Modifying a Trigger Policy Based on the Release Task ID

Function

This API is used to modify a release task trigger policy based on the release task ID.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:pipeline:modify	write	pipeline	g:EnterpriseProjectId	-	-

URI

PUT /v3/{project_id}/pipeline/pipelines/{pipeline_id}/hooks

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.
pipeline_id	Yes	String	Release task ID. See Obtaining the Release Task List.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
selected_tasks	No	List of object	Task to be executed. If this parameter is not transferred or is set to null, all tasks are executed. See Table 4.
strategy_type	Yes	Integer	Execution policy. 0: manual trigger 1: scheduled trigger
hooks	No	List of object	Scheduling policy. This parameter is mandatory when strategy_type is set to 1. See Table 5.

**Table 4** selected_tasks
Parameter	Mandatory	Type	Description
stage_name	Yes	String	Stage name.
tasks	Yes	List of string	Name of the task to be executed.

**Table 5** hooks
Parameter	Mandatory	Type	Description
schedule	Yes	String	Regular expression of the scheduling.
timezone_operator	Yes	String	Hour offset from the Coordinated Universal Time (UTC).
timezone_hour	Yes	Integer	Direction of the offset, that is, whether the time is advanced (+) or delayed (-).

Example Request

Modify a scheduled trigger policy for the release task.

{
    "selected_tasks": [
        {
            "stage_name": "75foki",
            "tasks": [
                "bkdi55"
            ]
        }
    ],
    "strategy_type": 1,
    "hooks": [
        {
            "schedule": "0 00-59/10 00-00 ? * MON *",
            "timezone_operator": "+",
            "timezone_hour": 8
        }
    ]
}