CreateApiDestination

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:CreateApiDestination

create

*ApiDestination

acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName}

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.	This is the description.
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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5DAF96FB-A4B6-548C-B999-0BFDCB22****
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

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
500	InternalError	InternalError
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	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	ApiDestinationCountExceedLimit	The current count of api-destination is [{0}], which will exceed the limit quota.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.