ListApiDestinations - EventBridge - Alibaba Cloud Documentation Center

Queries a list of API destinations.

Operation description

You can use this API operation to query a list of API destinations.

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
ApiDestinationNamePrefix	string	No	The prefix of the API destination name.	api-demo
ConnectionName	string	No	The connection name.	connection-name
MaxResults	long	No	The maximum number of entries to be returned in a call. You can use this parameter and NextToken to implement paging. Default value: 10.	10
NextToken	string	No	If you set Limit and excess return values exist, this parameter is returned. Default value: 0.	0

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	96D7C0AB-DCE5-5E82-96B8-4725E1706BB1
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.
ApiDestinations	object []	The API destinations.
ApiDestinationName	string	The name of the API destination.	api-destination-2
ConnectionName	string	The connection name.	connection-name
Description	string	The description of the connection.	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.	1665223213000
NextToken	string	If excess return values exist, this parameter is returned.	1
Total	float	The total number of entries returned.	2
MaxResults	float	The maximum number of entries returned per page.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "96D7C0AB-DCE5-5E82-96B8-4725E1706BB1",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ApiDestinations": [
      {
        "ApiDestinationName": "api-destination-2",
        "ConnectionName": "connection-name",
        "Description": "demo",
        "HttpApiParameters": {
          "Endpoint": "http://127.0.0.1:8001/api",
          "Method": "POST"
        },
        "GmtCreate": 1665223213000
      }
    ],
    "NextToken": "1",
    "Total": 2,
    "MaxResults": 10
  }
}

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.
	delete Error Codes: 409
	Added Error Codes: 500

2023-04-06

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

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 409
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ConnectionName
	delete Input Parameters: Description
Output Parameters	The response structure of the API has changed.