GetApiDestination - EventBridge - Alibaba Cloud Documentation Center

Queries the information about an API destination.

Operation description

You can call this API operation to query the information about 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.	api-destination-name

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	B896B484-F16D-59DE-9E23-DD0E5C361108
Message	string	The returned message. If the request is successful, success is returned. If the request failed, an error code is returned.	success
Code	string	The returned response code. The value Success indicates that the request is successful.	Success
Data	object	The returned data.
ApiDestinationName	string	The name of the API destination.	demo
ConnectionName	string	The connection name.	test-basic
Description	string	The description of the API destination.	demo
HttpApiParameters	object	The request parameters that are configured for the API destination.
Endpoint	string	The endpoint of the API destination.	http://127.0.0.1:8001/api
Method	string	The HTTP request method. Valid values: POST GET DELETE PUT HEAD TRACE PATCH	POST
GmtCreate	long	The time when the API destination was created.	1649055710565

Examples

Sample success responses

JSONformat

{
  "RequestId": "B896B484-F16D-59DE-9E23-DD0E5C361108",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ApiDestinationName": "demo",
    "ConnectionName": "test-basic",
    "Description": "demo",
    "HttpApiParameters": {
      "Endpoint": "http://127.0.0.1:8001/api\n",
      "Method": "POST"
    },
    "GmtCreate": 1649055710565
  }
}

Error codes

HTTP status code	Error code	Error message
409	RequestParameterException	Request parameter exception

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-06

The Error code has changed

see changesets

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