CreateApiDestination - EventBridge - Alibaba Cloud Documentation Center

Creates an API destination.

Operation description

You can call this API operation to create an API destination.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ApiDestinationName	string	Yes	The name of the API destination. The name must be 2 to 127 characters in length.	api-destination-name
ConnectionName	string	Yes	The name of the connection. The name must be 2 to 127 characters in length. Note Before you configure this parameter, you must call the CreateConnection operation to create a connection. Then, set this parameter to the name of the connection that you created.	connection-name
Description	string	No	The description of the API destination. The description can be up to 255 characters in length.
HttpApiParameters	object	Yes	The parameters that are configured for the API destination.
Endpoint	string	Yes	The endpoint of the API destination. The endpoint can be up to 127 characters in length.	http://127.0.0.1:8001/api
Method	string	Yes	The HTTP request method. Valid values: GET POST HEAD DELETE PUT PATCH	POST

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	5DAF96FB-A4B6-548C-B999-0BFDCB2261B9
Message	string	The returned message.	success
Code	string	The returned response code. The value Success indicates that the request is successful.	Success
Date	object	The data returned if the API destination is created.
ApiDestinationName	string	The name of the API destination.	ApiDestinationName

Examples

Sample success responses

JSONformat

{
  "RequestId": "5DAF96FB-A4B6-548C-B999-0BFDCB2261B9",
  "Message": "success",
  "Code": "Success",
  "Date": {
    "ApiDestinationName": "ApiDestinationName"
  }
}

Error codes

HTTP status code	Error code	Error message
409	RequestParameterException	Request parameter exception
409	RequestParameterInvalid	The ApiDestination name is invalid! Only letters a~z or A~Z, numbers 0~9, underscore (_) and dash (-) are supported.
409	RequestParameterInvalid	The connection name length cannot exceed 127.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-09-13

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 409 change
	Added Error Codes: 500

2023-04-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 409

2023-04-06

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 409 change
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: InvocationRateLimitPerSecond