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

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:ListApiDestinations	list	ApiDestination `acs:eventbridge:{#regionId}:{#accountId}:apidestination/`	none	none

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	array<object>	The API destinations.
apiDestinations	object
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
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-06	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details