All Products
Search
Document Center

EventBridge:GetApiDestination

Last Updated:Dec 04, 2024

Queries the information about an API destination.

Operation description

You can call this API operation to query the information about 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:GetApiDestinationget
*ApiDestination
acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ApiDestinationNamestringYes

The name of the API destination.

api-destination-name

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

B896B484-F16D-59DE-9E23-DD0E5C361108
Messagestring

The returned message. If the request is successful, success is returned. If the request failed, an error code is returned.

success
Codestring

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

Success
Dataobject

The returned data.

ApiDestinationNamestring

The name of the API destination.

demo
ConnectionNamestring

The connection name.

test-basic
Descriptionstring

The description of the API destination.

demo
HttpApiParametersobject

The request parameters that are configured for the API destination.

Endpointstring

The endpoint of the API destination.

http://127.0.0.1:8001/api
Methodstring

The HTTP request method. Valid values:

  • POST
  • GET
  • DELETE
  • PUT
  • HEAD
  • TRACE
  • PATCH
POST
GmtCreatelong

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 codeError codeError message
409RequestParameterExceptionRequest parameter exception
409ApiDestinationNotExistThe api-destination not existed!
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-06The Error code has changedView Change Details