Help Center/ FunctionGraph/ API Reference (Kuala Lumpur Region)/ APIs/ Function Triggers/ Updating a Trigger
Updated on 2023-07-06 GMT+08:00
View PDF
Share

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

trigger_type_code

Yes

String

Trigger type code.

Enumeration values:

  • TIMER

  • APIG

  • CTS

  • DDS

  • DMS

  • DIS

  • LTS

  • OBS

  • SMN

  • KAFKA

  • RABBITMQ

  • DEDICATEDGATEWAY

  • OPENSOURCEKAFKA

  • APIC

  • GAUSSMONGO

  • EVENTGRID

  • IOTDA

trigger_id

Yes

String

Trigger ID.

Request Parameters

Table 2 Request header 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

trigger_status

No

String

Trigger status.

Enumeration values:

  • ACTIVE

  • DISABLED

event_data

No

Array of TriggerEventData objects

Trigger update event.
Table 4 TriggerEventData

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.

Enumeration 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

  • APIG

  • CTS

  • DDS

  • DMS

  • DIS

  • LTS

  • OBS

  • SMN

  • KAFKA

Enumeration values:

  • TIMER

  • APIG

  • CTS

  • DDS

  • DMS

  • DIS

  • LTS

  • OBS

  • SMN

  • KAFKA

  • RABBITMQ

  • DEDICATEDGATEWAY

  • OPENSOURCEKAFKA

  • APIC

  • GAUSSMONGO

  • EVENTGRID

  • IOTDA

trigger_status

String

Trigger status.

  • ACTIVE: The trigger is enabled.

  • DISABLED: The trigger is disabled.

Enumeration values:

  • ACTIVE

  • DISABLED

event_data

Object

Trigger source event.

last_updated_time

String

Latest update time.

created_time

String

Time when the trigger was created.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

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

Parent topic: Function Triggers