Help Center/ FunctionGraph/ API Reference (ME-Abu Dhabi Region)/ Function Management Zone APIs/ Querying the Information About a Trigger
Updated on 2022-02-22 GMT+08:00
View PDF
Share

Querying the Information About a Trigger

Function

This API is used to query the information about a trigger.

URI

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

Table 1 describes the URI parameters.

Table 1 URI parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Tenant's project ID.

function_urn

String

Yes

Function URN. See Function Model.

trigger_type_code

String

Yes

Trigger type code. Options: SMN, APIG, OBS, TIMER, CTS, and kafka.

trigger_id

String

Yes

Trigger ID.

Request

None

Response

Table 2 describes the response parameters.
Table 2 Response parameters

Parameter

Type

Description

trigger_id

String

Trigger ID.

trigger_type_code

String

Trigger type code.

trigger_status

String

Trigger status.

event_data

String

Trigger data defined in JSON format.

NOTE:

See Trigger Instance Data.

last_updated_time

String

Time when the trigger was last updated.

created_time

String

Time when the trigger was created.

Example

Example request

GET https://{functiongraph_endpoint}/v2/7aad83af3e8d42e99ac194e8419e2c9b/fgs/triggers/urn:fss:xxxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test:latest/TIMER/9a14fae1-78cf-4185-ac7a-429eb6dc41fb HTTP/1.1

Example response

The format of the response for a successful request is as follows:

{
  "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" : "2019-10-29T17:15:53+08:00",
  "created_time" : "2019-10-29T17:15:53+08:00"
}

The format of the response for a failed request is as follows:

{
  "error_code" : "FS.0019",
  "error_msg" : "Not found the function"
}

Status Code

See Status Codes.