CreateApiDestination_事件总线_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

用于创建 API 端点信息。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
eventbridge:CreateApiDestination
Create
ApiDestination
acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName}

请求参数

字段名称字段详情
ApiDestinationNamestring

API 名称,最大长度 127 个字符。最小长度 2 个字符。

示例值:api-destination-name参考取值来源:
    UpdateApiDestination
    ListApiDestinations
字符长度 <= 127字符长度 >= 2
ConnectionNamestring

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

示例值:connection-name参考取值来源:
    CreateConnection
    ListConnections
字符长度 <= 127字符长度 >= 2
Descriptionstring

API 描述,不超过 255 个字符。

示例值:连接配置描述信息字符长度 <= 255
HttpApiParametersobject

API 端点的配置信息。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:5DAF96FB-A4B6-548C-B999-0BFDCB22****
Messagestring

返回信息。

示例值:success
Codestring

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

示例值:Success
Dateobject

返回创建 API 端点成功数据结构。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
409
RequestParameterException
Request parameter exception诊断
409
RequestParameterInvalid
The ApiDestination name is invalid! Only letters a~z or A~Z, numbers 0~9, underscore (_) and dash (-) are supported.诊断
409
ApiDestinationAlreadyExist
The api-destination already existed!诊断
409
ConnectionNotExist
The Connection 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
ApiDestinationCountExceedLimit
The current count of api-destination is [{0}], which will exceed the limit quota.诊断
500
InternalError
InternalError诊断

变更历史

变更时间变更内容概要操作
2023-09-13
变更错误码409
新增错误码500
2023-04-12
变更请求参数ApiDestinationName
变更请求参数ConnectionName
2023-04-06
变更错误码409
删除请求参数InvocationRateLimitPerSecond
变更请求参数ApiDestinationName
变更请求参数ConnectionName
变更请求参数Description
变更请求参数HttpApiParameters
删除返回参数

相关示例