UpdateApiDestination - 更新API 端点

更新时间:
复制为 MD 格式

更新API 端点。

接口说明

用于更新 API 端点相关配置信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:UpdateApiDestination

update

*ApiDestination

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

请求参数

名称

类型

必填

描述

示例值

Description

string

API 端点描述信息,最大长度 255 个字符。

demo

ApiDestinationName

string

需要更新的 API 端点名称,最大长度 127 个字符。最小长度 2 个字符。

api-destination-name

ConnectionName

string

连接配置名称。最大长度 127 个字符。最小长度 2 个字符。

提示 : 需要先调用 Connection 接口创建连接配置,ConnectionName 填写已存在的连接名称

connection-name

HttpApiParameters

object

API 端点的配置信息

Endpoint

string

API 端点的接入点地址。最大长度 127 个字符。

http://127.0.0.1:8001/api

Method

string

HTTP 请求方法。

  • GET

  • POST

  • HEAD

  • DELETE

  • PUT

  • PATCH

POST

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID

382E6272-8E9C-5681-AC96-A8AF0BFAC1A5

Message

string

响应消息,若成功请求为 success

success

Code

string

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

Success

ApiDestinationName

string

API 端点名称。

api-destination-name

示例

正常返回示例

JSON格式

{
  "RequestId": "382E6272-8E9C-5681-AC96-A8AF0BFAC1A5",
  "Message": "success",
  "Code": "Success",
  "ApiDestinationName": "api-destination-name"
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError InternalError
409 RequestParameterException Request parameter exception
409 ApiDestinationNotExist The api-destination not existed!
409 HttpApiParametersIsNull HttpApiParameters is null!
409 EndpointIsBlank Endpoint is blank!
409 Method Method is blank!
409 EndpointLengthExceed Endpoint length cannot exceed 127!
409 ConnectionNotExist The Connection not existed!

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

变更历史

更多信息,参考变更详情