CreateApiDestination - EventBridge - Alibaba Cloud Documentation Center

Creates an API destination.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eventbridge:CreateApiDestination	create	*ApiDestination `acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName}`	none	none

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.
409	ApiDestinationAlreadyExist	The api-destination already existed!
409	ConnectionNotExist	The Connection not existed!
409	HttpApiParametersIsNull	HttpApiParameters is null!
409	EndpointIsBlank	Endpoint is blank!
409	Method	Method is blank!
409	EndpointLengthExceed	Endpoint length cannot exceed 127!
409	ApiDestinationAlreadyExist	The api-destination already existed!
409	ApiDestinationCountExceedLimit	The current count of api-destination is [{0}], which will exceed the limit quota.
500	InternalError	InternalError

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	View Change Details
2023-04-12	The Error code has changed	View Change Details
2023-04-06	The Error code has changed. The request parameters of the API has changed	View Change Details