ListApiDestinations - Query API destinations - EventBridge

Queries a list of API destinations.

Operation description

Queries a list of API destinations.

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:ListApiDestinations

list

*ApiDestination

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

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	integer	No	The maximum number of entries per page. Used with NextToken for pagination. Default value: 10.	10
NextToken	string	No	The pagination token. Returned when more results are available. Default value: 0.	0

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	96D7C0AB-DCE5-5E82-96B8-4725E1706BB1
Message	string	The response message. Returns `success` on success, or an error code on failure.	success
Code	string	The response code. `Success` indicates a successful request.	Success
Data	object	The response data.
ApiDestinations	array<object>	The API destinations.
	array<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 HTTP request parameters of 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	integer	The time when the API destination was created.	1665223213000
NextToken	string	The pagination token for the next page. Returned when more results are available.	1
Total	number	The total number of entries returned.	2
MaxResults	number	The maximum number of entries returned per page.	10

Examples

Success response

JSON format

{
  "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	Description
500	InternalError	InternalError
409	RequestParameterException	Request parameter exception

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.