On this page

Show all

Help Center/ EventGrid/ API Reference/ APIs/ Trigger Management/ Obtaining the EG Trigger of a Function Flow

Obtaining the EG Trigger of a Function Flow

Updated on 2025-05-06 GMT+08:00

View PDF

Function

This API is used to obtain the trigger of a function flow specified by ID. A trigger is a subscription with a function flow ID as the target.

URI

GET /v1/{project_id}/subscription-triggers/workflow/{workflow_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.
workflow_id	Yes	String	ID of the function flow.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
limit	No	Integer	Number of records displayed on each page. The value must be within the range [1, 1000].
sort	No	String	Sorting mode of the query results.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token 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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of records.
size	Integer	Number of records displayed on the current page.
items	Array of SubscriptionInfo objects	Object list.

**Table 5** SubscriptionInfo
Parameter	Type	Description
id	String	Subscription ID.
name	String	Subscription name.
description	String	Description of the subscription.
type	String	Subscription type.
status	String	Status.
channel_id	String	ID of the event channel.
channel_name	String	Name of the event channel.
used	Array of SubscriptionUsedInfo objects	Label information.
sources	Array of SubscriptionSourceInfo objects	List of subscription sources.
targets	Array of SubscriptionTargetInfo objects	List of subscription targets.
created_time	String	Time when the trigger is created.
updated_time	String	Time when the trigger is updated.

**Table 6** SubscriptionUsedInfo
Parameter	Type	Description
resource_id	String	Associated resource ID.
owner	String	Management tenant account.
description	String	Description.

**Table 7** SubscriptionSourceInfo
Parameter	Type	Description
id	String	ID of the event subscription source.
name	String	Name of the event subscription source.
provider_type	String	Provider type of the event subscription source.
detail	Object	List of event subscription source parameters.
filter	Object	Filtering rule of the event subscription source.
created_time	String	Time when the event subscription is created.
updated_time	String	Time when the event subscription is updated.

**Table 8** SubscriptionTargetInfo
Parameter	Type	Description
id	String	ID of the event subscription target.
name	String	Name of the event subscription target.
provider_type	String	Provider type of the event subscription target.
connection_id	String	Connection ID used by the event subscription target.
detail	Object	List of event subscription target parameters.
kafka_detail	KafkaTargetDetail object	List of Kafka event subscription target parameters. The total length of this field after serialization cannot exceed 1024 bytes.
smn_detail	SmnTargetDetail object	List of SMN event target parameters for the subscription. The total length cannot exceed 1024 bytes after serialization.
eg_detail	EgTargetDetail object	List of EG event channel target parameters for the subscription. The total length cannot exceed 1,024 bytes after serialization. This field is mandatory for EG channel event targets.
apigw_detail	ApigwTargetDetail object	List of APIGW URL target parameters for the subscription. The total length cannot exceed 1,024 bytes after serialization. This field is mandatory for APIGW event targets.
retry_times	Integer	Number of retries.
transform	TransForm object	Transform rule of the event subscription target.
dead_letter_queue	DeadLetterQueue object	List of dead letter queue parameters for the subscription.
created_time	String	Time when the event subscription is created.
updated_time	String	Time when the event subscription is updated.

**Table 9** KafkaTargetDetail
Parameter	Type	Description
topic	String	Topic.
keyTransform	keyTransform object	Key value rule.

**Table 10** keyTransform
Parameter	Type	Description
type	String	Type of the key value rule.
value	String	Key value rule. This parameter is mandatory when type is VARIABLE or CONSTANT.
template	String	Key value rule template. This parameter is mandatory when type is VARIABLE.

**Table 11** SmnTargetDetail
Parameter	Type	Description
urn	String	Specifies the topic URN.
agency_name	String	Agency name.
subject_transform	subject_transform object	Title rule.

**Table 12** subject_transform
Parameter	Type	Description
type	String	Type of the title rule.
value	String	Title rule.
template	String	Title rule template. This parameter is mandatory when type is set to VARIABLE.

**Table 13** EgTargetDetail
Parameter	Type	Description
target_project_id	String	Target project ID.
target_channel_id	String	Target channel ID.
target_region	String	Target region.
cross_region	Boolean	Indicates whether cross-region feature is enabled.
cross_account	Boolean	Indicates whether cross-account feature is enabled.
agency_name	String	Agency name.

**Table 14** ApigwTargetDetail
Parameter	Type	Description
url	String	Target URL.
invocation_http_parameters	InvocationHttpParameters object	Parameters for invoking HTTP.

**Table 15** InvocationHttpParameters
Parameter	Type	Description
header_parameters	Array of HeaderParameter objects	Object list.

**Table 16** HeaderParameter
Parameter	Type	Description
is_value_secret	Boolean	Whether to encrypt the value.
key	String	Header key.
value	String	Header value.

**Table 17** TransForm
Parameter	Type	Description
type	String	Type of the transform rule.
value	String	For a constant type rule, the field is the constant content definition. For a variable type rule, the field is a variable definition and the content must be a JSON object string. A maximum of 100 variables are supported, and nested structures are not supported. The variable name can contain a maximum of 64 characters. Only letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. It must start with a letter or digit and cannot start with HC.. The variable value expression can be a constant or JSONPath expression. The string length cannot exceed 1024 characters.
template	String	Template definition of the rule content when the rule is of the variable type. Defined variables can be referenced.

**Table 18** DeadLetterQueue
Parameter	Type	Description
type	String	Queue type.
instance_id	String	Instance ID.
connection_id	String	Connection ID.
topic	String	Topic.

Example Requests

Obtain the EG trigger of a function flow.

GET https://{endpoint}/v1/{project_id}/subscription-triggers/workflow/{workflow_id}

Example Responses

Status code: 200

Operation successful.

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

Status Codes


Status Code	Description
200	Operation successful.

Error Codes

See Error Codes.

Parent topic: Trigger Management

Previous topic: Obtaining the EG Trigger of a Function

Next topic: Endpoint Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot