UpdateApiDestination - 更新API 端点

更新API 端点。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

demo
ApiDestinationNamestring

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

api-destination-name
ConnectionNamestring

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

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

connection-name
HttpApiParametersobject

API 端点的配置信息

Endpointstring

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

http://127.0.0.1:8001/api
Methodstring

HTTP 请求方法。

  • GET
  • POST
  • HEAD
  • DELETE
  • PUT
  • PATCH
POST

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

382E6272-8E9C-5681-AC96-A8AF0BFAC1A5
Messagestring

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

success
Codestring

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

Success
ApiDestinationNamestring

API 端点名称。

api-destination-name

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
409RequestParameterExceptionRequest parameter exception
409ApiDestinationNotExistThe api-destination not existed!
409HttpApiParametersIsNullHttpApiParameters is null!
409EndpointIsBlankEndpoint is blank!
409MethodMethod is blank!
409EndpointLengthExceedEndpoint length cannot exceed 127!
409ConnectionNotExistThe Connection not existed!
500InternalErrorInternalError

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

变更历史

变更时间变更内容概要操作
2023-09-13OpenAPI 错误码发生变更查看变更详情
2023-04-12OpenAPI 错误码发生变更查看变更详情
2023-04-06OpenAPI 错误码发生变更查看变更详情