SinkApiDestinationParameters - EventBridge - Alibaba Cloud Documentation Center

Parameter	Type	Description
	object	Specifies the parameters for the API destination.
Name	string	The name of the API destination.
HeaderParameters	object	The custom HTTP header parameters to add to the request, specified as key-value pairs.
Form	string	Defines how the parameter's value is created. Use `CONSTANT` to specify a static string in the `value` field. Use `JSONPATH` to extract data from the event payload with a JSONPath expression in the `value` field. Use `TEMPLATE` to build the value from the `template` field.
Value	string	The static value or JSONPath expression for the parameter. This field applies only when the `form` is set to `CONSTANT` or `JSONPATH`.
Template	string	The template to use to build the parameter value. This field is used only when the `form` is set to `TEMPLATE`. You can use variables, such as `${event.id}`, in the template to reference event data.
BodyParameters	object	The parameters for the HTTP request body, specified as key-value pairs.
Form	string	Defines how the parameter's value is created. Use `CONSTANT` to specify a static string in the `value` field. Use `JSONPATH` to extract data from the event payload with a JSONPath expression in the `value` field. Use `TEMPLATE` to build the value from the `template` field.
Value	string	The static value or JSONPath expression for the parameter. This field applies only when the `form` is set to `CONSTANT` or `JSONPATH`.
Template	string	The template to use to build the parameter value. This field is used only when the `form` is set to `TEMPLATE`. You can use variables, such as `${event.id}`, in the template to reference event data.
QueryStringParameters	object	The query string parameters to add to the endpoint URL, specified as key-value pairs.
Form	string	Defines how the parameter's value is created. Use `CONSTANT` to specify a static string in the `value` field. Use `JSONPATH` to extract data from the event payload with a JSONPath expression in the `value` field. Use `TEMPLATE` to build the value from the `template` field.
Value	string	The static value or JSONPath expression for the parameter. This field applies only when the `form` is set to `CONSTANT` or `JSONPATH`.
Template	string	The template to use to build the parameter value. This field is used only when the `form` is set to `TEMPLATE`. You can use variables, such as `${event.id}`, in the template to reference event data.
Timeout	integer	The timeout for the API call, in seconds. If the endpoint does not respond within this period, the call fails. The valid range is 1 to 60.

object

Specifies the parameters for the API destination.

Name

string

The name of the API destination.

HeaderParameters

object

The custom HTTP header parameters to add to the request, specified as key-value pairs.

Form

string

Defines how the parameter's value is created. Use CONSTANT to specify a static string in the value field. Use JSONPATH to extract data from the event payload with a JSONPath expression in the value field. Use TEMPLATE to build the value from the template field.

Value

string

The static value or JSONPath expression for the parameter. This field applies only when the form is set to CONSTANT or JSONPATH.

Template

string

The template to use to build the parameter value. This field is used only when the form is set to TEMPLATE. You can use variables, such as ${event.id}, in the template to reference event data.

BodyParameters

object

The parameters for the HTTP request body, specified as key-value pairs.

Form

string

Defines how the parameter's value is created. Use CONSTANT to specify a static string in the value field. Use JSONPATH to extract data from the event payload with a JSONPath expression in the value field. Use TEMPLATE to build the value from the template field.

Value

string

The static value or JSONPath expression for the parameter. This field applies only when the form is set to CONSTANT or JSONPATH.

Template

string

The template to use to build the parameter value. This field is used only when the form is set to TEMPLATE. You can use variables, such as ${event.id}, in the template to reference event data.

QueryStringParameters

object

The query string parameters to add to the endpoint URL, specified as key-value pairs.

Form

string

Defines how the parameter's value is created. Use CONSTANT to specify a static string in the value field. Use JSONPATH to extract data from the event payload with a JSONPath expression in the value field. Use TEMPLATE to build the value from the template field.

Value

string

The static value or JSONPath expression for the parameter. This field applies only when the form is set to CONSTANT or JSONPATH.

Template

string

The template to use to build the parameter value. This field is used only when the form is set to TEMPLATE. You can use variables, such as ${event.id}, in the template to reference event data.

Timeout

integer

The timeout for the API call, in seconds. If the endpoint does not respond within this period, the call fails. The valid range is 1 to 60.