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}
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 description. |
trigger_type_code |
Yes |
String |
Trigger type code. Enumeration values:
|
trigger_id |
Yes |
String |
Trigger ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It 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. |
Content-Type |
Yes |
String |
Message body type (format). Default: application/json |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
trigger_status |
No |
String |
Trigger status. Enumeration values:
|
event_data |
No |
Array of UpdateriggerEventData objects |
Trigger update event. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
trigger_id |
String |
Trigger ID. |
trigger_type_code |
String |
Trigger type.
Enumeration values:
|
trigger_status |
String |
Trigger status.
Enumeration values:
|
event_data |
TriggerEventDataResponseBody object |
Trigger source event. |
last_updated_time |
String |
Latest update time. |
created_time |
String |
Time when the trigger was created. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Trigger name. |
schedule_type |
String |
Timer trigger type (timer trigger parameter).
Enumeration values:
|
schedule |
String |
Triggering rule. (timer trigger parameter).
|
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 |
The API type (APIG trigger parameter).
|
path |
String |
Path of the API (APIG trigger parameter). |
protocol |
String |
Request protocol of the API (APIG trigger parameter). Enumeration values:
|
req_method |
String |
Request mode of the API (APIG trigger parameter). Enumeration values:
|
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).
Enumeration values:
|
env_name |
String |
Environment in which the API is published (APIG trigger parameter). |
env_id |
String |
ID of the environment in which the API has been published (APIG trigger parameter). |
api_id |
String |
API ID (APIG trigger parameter). |
api_name |
String |
API name (APIG trigger parameter). |
auth |
String |
Security authentication (APIG trigger parameter).
Enumeration values:
|
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: 1 Maximum: 255 |
backend_type |
String |
Backend type of the API (APIG trigger parameter). Enumeration values:
|
instance_id |
String |
Instance ID. This parameter is mandatory for DDS, Kafka, and RabbitMQ triggers.
|
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 |
DDS database password (DDS trigger parameter). |
db_user |
String |
DDS database username (DDS trigger parameter). |
instance_addrs |
Array of strings |
DDS database instance address (DDS trigger parameter). |
mode |
String |
DDS database instance type (DDS trigger parameter).
|
batch_size |
Integer |
Batch size: Maximum number of data records that can be processed by the function at a time. This parameter is mandatory for DIS, DDS, Kafka, and RabbitMQ triggers.
|
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 |
Start position (DIS trigger parameter).
Enumeration values:
|
polling_unit |
String |
Unit of the pull period (DIS trigger parameter).
Enumeration values:
|
max_fetch_bytes |
Integer |
Maximum number of bytes to be extracted (DIS trigger parameter). Minimum: 0 Maximum: 4194304 |
is_serial |
String |
Serial Data Processing: 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. Enumeration values:
|
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: 1 Maximum: 64 |
prefix |
String |
Prefix (OBS trigger parameter). Enter a prefix to limit notifications to objects whose names start with the matching characters. Minimum: 0 Maximum: 1024 |
suffix |
String |
Suffix (OBS trigger parameter). Enter a suffix to limit notifications to objects whose names end with the matching characters. Minimum: 0 Maximum: 1024 |
events |
Array of strings |
Trigger event (OBS trigger parameter).
|
topic_urn |
String |
Topic URN (SMN trigger parameter) Minimum: 1 Maximum: 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 password (Kafka trigger parameter). |
kafka_connect_address |
String |
Kafka instance connection address (Kafka trigger parameter). |
kafka_ssl_enable |
Boolean |
Whether to enable SASL authentication(Kafka trigger parameter). |
access_password |
String |
RabbitMQ account password (RabbitMQ trigger parameter). |
access_user |
String |
RabbitMQ username (RabbitMQ trigger parameter). |
connect_address |
String |
Instance IP address (RabbitMQ trigger parameter). |
exchange_name |
String |
Switch name (RabbitMQ trigger parameter). |
vhost |
String |
Virtual host (RabbitMQ trigger parameter). |
ssl_enable |
Boolean |
Whether to enable SSL (RabbitMQ trigger parameter). |
Parameter |
Type |
Description |
---|---|---|
function_urn |
String |
Function URN. For details, see the function model descriptions. |
invocation_type |
String |
Execution mode of a function.
Enumeration values:
|
timeout |
Integer |
Timeout allowed for APIG to request the FunctionGraph service. The unit is in millisecond. This parameter is mandatory for APIG triggers. Minimum: 1 Maximum: 60000 |
version |
String |
Function version information. |
Status code: 404
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.