文档

GetApiDestination - 查询单个API 端点信息

更新时间:

查询单个API 端点信息。

接口说明

用于查询单个 API 端点信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eventbridge:GetApiDestinationRead
  • ApiDestination
    acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName}

请求参数

名称类型必填描述示例值
ApiDestinationNamestring

API 端点名称

api-destination-name

返回参数

名称类型描述示例值
object
RequestIdstring

阿里云为该请求生成的唯一标识符。

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

附加信息。取值说明如下:请求正常,返回 success。 请求异常,返回具体异常错误码。

success
Codestring

接口状态或 POP 错误码。取值说明如下:Success:成功。

Success
Dataobject

返回结果。

ApiDestinationNamestring

API 端点名称

demo
ConnectionNamestring

连接配置名称

test-basic
Descriptionstring

API 的描述信息。

demo
HttpApiParametersobject

API 端点请求配置信息

Endpointstring

API 端点的接入点地址

http://127.0.0.1:8001/api
Methodstring

HTTP 请求方法。

  • POST

  • GET

  • DELETE

  • PUT

  • HEAD

  • TRACE

  • PATCH

POST
GmtCreatelong

创建时间。

1649055710565

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

HTTP status code错误码错误信息
409RequestParameterExceptionRequest parameter exception
409ApiDestinationNotExistThe api-destination not existed!
500InternalErrorInternalError

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 409 变更
    新增错误码:500
2023-04-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:409