All Products
Search
Document Center

EventBridge:CreateApiDestination

Last Updated:Dec 04, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
eventbridge:CreateApiDestinationcreate
*ApiDestination
acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ApiDestinationNamestringYes

The name of the API destination. The name must be 2 to 127 characters in length.

api-destination-name
ConnectionNamestringYes

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
DescriptionstringNo

The description of the API destination. The description can be up to 255 characters in length.

HttpApiParametersobjectYes

The parameters that are configured for the API destination.

EndpointstringYes

The endpoint of the API destination. The endpoint can be up to 127 characters in length.

http://127.0.0.1:8001/api
MethodstringYes

The HTTP request method. Valid values:

  • GET
  • POST
  • HEAD
  • DELETE
  • PUT
  • PATCH
POST

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

5DAF96FB-A4B6-548C-B999-0BFDCB2261B9
Messagestring

The returned message.

success
Codestring

The returned response code. The value Success indicates that the request is successful.

Success
Dateobject

The data returned if the API destination is created.

ApiDestinationNamestring

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 codeError codeError message
409RequestParameterExceptionRequest parameter exception
409RequestParameterInvalidThe ApiDestination name is invalid! Only letters a~z or A~Z, numbers 0~9, underscore (_) and dash (-) are supported.
409RequestParameterInvalidThe connection name length cannot exceed 127.
409ApiDestinationAlreadyExistThe api-destination already existed!
409ConnectionNotExistThe Connection not existed!
409HttpApiParametersIsNullHttpApiParameters is null!
409EndpointIsBlankEndpoint is blank!
409MethodMethod is blank!
409EndpointLengthExceedEndpoint length cannot exceed 127!
409ApiDestinationAlreadyExistThe api-destination already existed!
409ApiDestinationCountExceedLimitThe current count of api-destination is [{0}], which will exceed the limit quota.
500InternalErrorInternalError

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

Change history

Change timeSummary of changesOperation
2023-09-13The Error code has changedView Change Details
2023-04-12The Error code has changedView Change Details
2023-04-06The Error code has changed. The request parameters of the API has changedView Change Details