Updated on 2025-08-30 GMT+08:00

Updating a Trigger

Function

This API is used to update a trigger.

URI

PUT /v2/{project_id}/fgs/triggers/{function_urn}/{trigger_type_code}/{trigger_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

function_urn

Yes

String

Function URN. For details, see the function model descriptions.

trigger_type_code

Yes

String

Trigger type.

  • TIMER
  • APIC: API Connect (APIC) (only available in AP-Singapore)
  • DEDICATEDGATEWAY: API Gateway (Dedicated)
  • CTS: Cloud Trace Service (CTS): Enable CTS first. (available in CN North-Beijing4, CN East-Shanghai1, CN-Hong Kong, AP-Bangkok, AP-Singapore, ME-Riyadh, TR-Istanbul, LA-Mexico City2, and LA-Sao Paulo1)
  • DDS: Document Database Service (DDS): Configure a VPC for the function first. (available in CN North-Beijing4, CN East-Shanghai1, and CN-Hong Kong)
  • DMS: Distributed Message Service (DMS)
  • GAUSSMONGO: GeminiDB Mongo (available in CN North-Beijing4, CN East-Shanghai1, and AP-Singapore)
  • DIS: Data Ingestion Service (DIS) (available in CN East-Shanghai1, CN-Hong Kong, and AP-Singapore)
  • LTS: Log Tank Service (LTS): Configure an LTS agency first. (available at all regions except LA-Sao Paulo1)
  • KAFKA: DMS (for Kafka): Configure a DMS agency first. (available at all regions except LA-Sao Paulo1)
  • OBS: Object Storage Service (OBS) (available at CN-Hong Kong, AP-Bangkok, AP-Singapore, AP-Jakarta, TR-Istanbul, and LA-Mexico City2)
  • SMN: Simple Message Notification (SMN) (available at CN North-Beijing4, CN East-Shanghai1, CN-Hong Kong, AP-Bangkok, AP-Singapore, TR-Istanbul, LA-Sao Paulo1, and LA-Santiago)
  • OPENSOURCEKAFKA: Kafka (Open-Source) (available at CN North-Beijing4, CN East-Shanghai1, CN-Hong Kong, AP-Bangkok, AP-Singapore, and LA-Santiago)
  • RABBITMQ: DMS (for RabbitMQ): Configure a DMS agency first. (available at CN North-Beijing4, CN East-Shanghai1, AP-Bangkok, AP-Singapore, LA-Mexico City2, and LA-Sao Paulo1)
  • IOTDA: IoT Device Access (IoTDA) (available at CN North-Beijing4, CN-Hong Kong, and AP-Bangkok)
  • EVENTGRID: EventGrid (EG) (available at AP-Bangkok, AP-Singapore, AF-Johannesburg, LA-Mexico City2, and LA-Santiago)
  • ROCKETMQ: Distributed Message Service (DMS) for RocketMQ

trigger_id

Yes

String

Trigger ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

Message body type or format.

Default value: application/json

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

trigger_status

No

String

Trigger status.

Enumerated values:

  • ACTIVE
  • DISABLED

event_data

No

Array of UpdateriggerEventData objects

Trigger update event.

Table 4 UpdateriggerEventData

Parameter

Mandatory

Type

Description

is_serial

No

Boolean

Serial data processing.

max_fetch_bytes

No

Integer

Max. bytes.

polling_interval

No

Integer

Pull period.

polling_unit

No

String

Pull period unit.

Enumerated values:

  • ms
  • s

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

trigger_id

String

Trigger ID.

trigger_type_code

String

Trigger type.

  • TIMER
  • APIC: API Connect (APIC) (only available in AP-Singapore)
  • DEDICATEDGATEWAY: API Gateway (Dedicated)
  • CTS: Cloud Trace Service (CTS) (available in CN North-Beijing4, CN East-Shanghai1, CN-Hong Kong, AP-Bangkok, AP-Singapore, ME-Riyadh, TR-Istanbul, LA-Mexico City2, and LA-Sao Paulo1)
  • DDS: Document Database Service (DDS) (available in CN North-Beijing4, CN East-Shanghai1, and CN-Hong Kong)
  • DMS: Distributed Message Service (DMS)
  • GAUSSMONGO: GeminiDB Mongo (available in CN North-Beijing4, CN East-Shanghai1, and AP-Singapore)
  • DIS: Data Ingestion Service (DIS) (available in CN East-Shanghai1, CN-Hong Kong, and AP-Singapore)
  • LTS: Log Tank Service (LTS) (available at all regions except LA-Sao Paulo1)
  • KAFKA: DMS (for Kafka) (available at all regions except LA-Sao Paulo1)
  • OBS: Object Storage Service (OBS) (available at CN-Hong Kong, AP-Bangkok, AP-Singapore, AP-Jakarta, TR-Istanbul, and LA-Mexico City2)
  • SMN: Simple Message Notification (SMN) (available at CN North-Beijing4, CN East-Shanghai1, CN-Hong Kong, AP-Bangkok, AP-Singapore, TR-Istanbul, LA-Sao Paulo1, and LA-Santiago)
  • OPENSOURCEKAFKA: Kafka (Open-Source) (available at CN North-Beijing4, CN East-Shanghai1, CN-Hong Kong, AP-Bangkok, AP-Singapore, and LA-Santiago)
  • RABBITMQ: DMS (for RabbitMQ) (available at CN North-Beijing4, CN East-Shanghai1, AP-Bangkok, AP-Singapore, LA-Mexico City2, and LA-Sao Paulo1)
  • IOTDA: IoT Device Access (IoTDA) (available at CN North-Beijing4, CN-Hong Kong, and AP-Bangkok)
  • EVENTGRID: EventGrid (EG) (available at AP-Bangkok, AP-Singapore, AF-Johannesburg, LA-Mexico City2, and LA-Santiago)
  • ROCKETMQ: Distributed Message Service (DMS) for RocketMQ

trigger_status

String

Trigger status.

  • ACTIVE: The trigger is enabled.
  • DISABLED: The trigger is disabled.

Enumerated values:

  • ACTIVE
  • DISABLED

event_data

TriggerEventDataResponseBody object

Trigger source event.

last_updated_time

String

Time when the trigger was last updated.

created_time

String

Time when the trigger was created.

Table 6 TriggerEventDataResponseBody

Parameter

Type

Description

name

String

Trigger name.

schedule_type

String

Timer trigger type (timer trigger parameter).

  • Rate: specifies the frequency (minutes, hours, or days) at which the function is invoked. If the unit is minute, the value cannot exceed 60. If the unit is hour, the value cannot exceed 24. If the unit is day, the value cannot exceed 30.
  • Cron: specifies a Cron expression to periodically invoke a function.

Enumerated values:

  • Rate
  • Cron

schedule

String

Triggering rule (timer trigger parameter).

  • When the trigger type is Rate, the scheduled rule is used.
  • When the trigger type is Cron, the Cron expression is used.

user_event

String

Additional information (timer trigger parameter). When the timer trigger triggers the function, the execution event (the event parameter of the function) is {"version": "v1.0", "time": "2018-06-01T08:30:00+08:00", "trigger_type": "TIMER", "trigger_name": "Timer_001", "user_event": "Additional information you entered"}.

triggerid

String

APIG trigger ID (APIG trigger parameter).

type

Integer

API type (APIG trigger parameter).

  • 1: public
  • 2: private

path

String

Path of the API (APIG trigger parameter).

protocol

String

Request protocol of the API (APIG trigger parameter).

Enumerated values:

  • HTTP
  • HTTPS

req_method

String

Request method of the API (APIG trigger parameter).

Enumerated values:

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

group_id

String

ID of the group to which the API belongs (APIG trigger parameter).

group_name

String

Name of the group to which the API belongs (APIG trigger parameter).

match_mode

String

Matching mode of the API (APIG trigger parameter).

  • SWA: prefix match
  • NORMAL: exact match

Enumerated values:

  • SWA
  • NORMAL

env_name

String

Environment in which the API is published (APIG trigger parameter).

env_id

String

ID of the environment in which the API is published (APIG trigger parameter).

api_id

String

API ID (APIG trigger parameter).

api_name

String

API name (APIG trigger parameter).

auth

String

API authentication mode (APIG trigger parameter).

  • IAM: IAM authentication. This mode grants access permissions to IAM users only and is of medium security.
  • APP: AppKey and AppSecret authentication. This mode is of high security and is recommended.
  • NONE: Authentication is not required. All users can access this API. This mode is not recommended.

Enumerated values:

  • IAM
  • APP
  • NONE

invoke_url

String

API calling address (APIG trigger parameter).

func_info

ApigTriggerFuncInfo object

FunctionGraph backend details (APIG trigger parameter). This parameter is mandatory for APIG triggers.

sl_domain

String

Subdomain name allocated by the APIG system by default (APIG trigger parameter).

Minimum length: 1

Maximum length: 255

backend_type

String

API backend type (APIG trigger parameter).

Enumerated values:

  • FUNCTION

instance_id

String

Instance ID. This parameter is mandatory for DDS, RabbitMQ, and RocketMQ and Kafka triggers.

  • APIG trigger: APIG gateway ID.
  • DDS trigger: DDS instance ID.
  • Kafka trigger: Kafka instance ID.
  • RabbitMQ trigger: RabbitMQ instance ID.
  • RocketMQ trigger: RocketMQ instance ID.

roma_app_id

String

ID of the integration application to which the API belongs (APIG trigger parameter).

operations

Array of strings

Custom operations (CTS trigger parameter). CTS collects operation records of subscribed cloud resources. If you create a function with a CTS trigger, collected operation records of specified cloud services will be passed as a parameter to invoke the function.

collection_name

String

Collection name (DDS trigger parameter).

db_name

String

Database name (DDS trigger parameter).

db_password

String

Database password (DDS trigger parameter).

db_user

String

Database username (DDS trigger parameter).

instance_addrs

Array of strings

Database instance address (DDS trigger parameter).

mode

String

Database instance type (DDS trigger parameter).

  • Sharding: cluster instance
  • ReplicaSet: replica set instance
  • Single: single node instance

batch_size

Integer

Batch size, that is, the maximum amount of data that can be processed at a time. This parameter is mandatory for DIS, DDS, Kafka, RocketMQ, and RabbitMQ triggers.

  • DDS trigger: Enter a value from 1 to 10,000.
  • DIS trigger: Enter a value from 1 to 10,000.
  • Kafka trigger: Enter a value from 1 to 1,000.
  • RabbitMQ trigger: Enter a value from 1 to 1,000.
  • RocketMQ trigger: Enter a value from 1 to 1,000.

queue_id

String

Queue ID (DMS trigger parameter).

consumer_group_id

String

Consumer group ID (DMS trigger parameter).

polling_interval

Integer

Pull period.

stream_name

String

Stream name (DIS trigger parameter).

sharditerator_type

String

Starting position (DIS trigger parameter).

  • TRIM_HORIZON: Data is read from the earliest valid records that are stored in the partition.
  • LATEST: Data is read from the latest record in the partition. This option ensures that the most recent data in the partition is read.

Enumerated values:

  • TRIM_HORIZON
  • LATEST

polling_unit

String

Pull period unit (DIS trigger parameter).

  • s: second
  • ms indicates the millisecond.

Enumerated values:

  • s
  • ms

max_fetch_bytes

Integer

Max. fetch bytes (DIS trigger parameter).

Minimum value: 0

Maximum value: 4194304

is_serial

String

Serial data processing (DIS trigger parameter): If this option is selected, FunctionGraph pulls data from the stream only after previous data is processed. If this option is not selected, FunctionGraph pulls data from the stream as long as the pull period ends.

Enumerated values:

  • true
  • false

log_group_id

String

Log group ID (LTS trigger parameter).

log_topic_id

String

Log stream ID (LTS trigger parameter).

bucket

String

Bucket name (OBS trigger parameter). The name of the OBS bucket used as the event source cannot be the same as that of an existing bucket of the current user or another user. After being created, the bucket name cannot be modified.

Minimum length: 1

Maximum length: 64

prefix

String

Prefix (OBS trigger parameter). Enter a prefix to limit notifications to objects whose names start with the matching characters.

Minimum length: 0

Maximum length: 1024

suffix

String

Suffix (OBS trigger parameter). Enter a suffix to limit notifications to objects whose names end with the matching characters.

Minimum length: 0

Maximum length: 1024

events

Array of strings

Events (OBS trigger parameter).

  • ObjectCreated: all kinds of object creation operations, including PUT, POST, COPY, and part assembling
  • Put: object upload using PUT
  • Post: object upload using POST
  • Copy: object copying using COPY
  • CompleteMultipartUpload: Assemble parts in a multipart upload.
  • ObjectRemoved: deleting objects
  • Delete: object deletion with a version ID specified
  • DeleteMarkerCreated: object deletion with no version ID specified

topic_urn

String

Topic URN (SMN trigger parameter)

Minimum length: 1

Maximum length: 255

topic_ids

Array of strings

The Kafka topic ID list (Kafka trigger parameter).

kafka_user

String

Kafka account name (Kafka trigger parameter).

kafka_password

String

Kafka account password (Kafka trigger parameter).

kafka_connect_address

String

Kafka instance connection address (Kafka trigger parameter).

kafka_ssl_enable

Boolean

Whether to enable security authentication (Kafka trigger parameter).

access_password

String

RabbitMQ account password (RabbitMQ trigger parameter).

access_user

String

RabbitMQ account name (RabbitMQ trigger parameter).

connect_address

String

Instance connection IP address (RabbitMQ trigger parameter).

exchange_name

String

Exchange name (RabbitMQ trigger parameter).

vhost

String

Virtual host (RabbitMQ trigger parameter).

ssl_enable

Boolean

Whether to enable security authentication (RabbitMQ trigger parameter).

enable_acl

Boolean

Explanation

Whether to enable username and password authentication (RocketMQ trigger parameter).

Value range

  • true: yes

false: no

access_key

String

Explanation

Connection username (RocketMQ trigger parameter). This parameter is mandatory when enable_acl is set to true.

Value range

None

secret_key

String

Explanation

Connection password (RocketMQ trigger parameter). This parameter is mandatory when enable_acl is set to true.

Value range

None

Table 7 ApigTriggerFuncInfo

Parameter

Type

Description

function_urn

String

Function URN. For details, see the function model descriptions.

invocation_type

String

Execution mode of a function.

  • sync: synchronous execution
  • async: asynchronous execution

Enumerated values:

  • sync
  • async

timeout

Integer

Timeout allowed for APIG to request the FunctionGraph service. Unit: millisecond. This parameter is mandatory for APIG triggers.

Minimum value: 1

Maximum value: 60000

version

String

Function version information.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Enable a trigger.

PUT https://{Endpoint}/v2/{project_id}/fgs/triggers/{function_urn}/{trigger_type_code}/{trigger_id}

{
  "trigger_status" : "ACTIVE"
}

Example Responses

Status code: 200

OK

{
  "trigger_id" : "9a14fae1-78cf-4185-ac7a-429eb6dc41fb",
  "trigger_type_code" : "TIMER",
  "trigger_status" : "ACTIVE",
  "event_data" : {
    "name" : "Timer-cpg3",
    "schedule" : "3m",
    "schedule_type" : "Rate"
  },
  "last_updated_time" : "2022-11-09 16:37:24",
  "created_time" : "2019-10-29171553"
}

Status code: 404

Not Found

{
  "error_code" : "FSS.0404",
  "error_msg" : "not found"
}

Status Codes

Status Code

Description

200

OK

404

Not Found

Error Codes

See Error Codes.