Creating a Test Event¶

Function¶

This API is used to create a test event.

POST /v2/{project_id}/fgs/functions/{function_urn}/events

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

**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.
Content-Type	Yes	String	Message body type (format).

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
name	Yes	String	Test event name. Max. 25 of letters, digits, hyphens (-), and underscores (_). Start with a letter, and end with a letter or digit. Minimum length: 1 character. Maximum length: 25 characters.
content	Yes	String	Test event content, which is a Base64-encoded JSON character string.

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
id	String	Test event ID.
name	String	Test event name.

Status code: 400

**Table 5** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Create a test event named event-xx with content {"k":"v"}.

POST https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn}/events

{
  "name" : "event-xx",
  "content" : "eyJrIjoidiJ9"
}

Status code: 200

{
  "id" : "3b659dc0-12fc-40dc-aa05-a321d9424cb3",
  "name" : "event-k9r3"
}

last updated: 2024-11-13 14:32 UTC - commit: b76006b7a8a959522accffb756d2ecb3b9ebe5d2