文档

CreateExchange - 创建Exchange

更新时间:
一键部署

Producer将消息发送到Exchange,由Exchange将消息路由到一个或多个Queue中(或者丢弃)。Exchange根据Routing Key和Binding Key将消息路由到Queue。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

amqp-cn-v0h1kb9nu***
VirtualHoststring

Exchange 所在的 Vhost 名称。

test
ExchangeNamestring

Exchange 名称。说明:

  • Exchange 名称只能包含字母、数字、短划线(-)、下划线(_)、半角句号(.)、井号(#)、正斜线(/)、at 符号(@),长度限制 1~255 字符。

  • Exchange 创建后,名称不支持修改,只能删除后重建。

DemoExchange
ExchangeTypestring

Exchange 类型。取值:

  • DIRECT:该类型路由规则会将消息路由到 Binding Key 与 Routing Key 完全匹配的 Queue 中。

  • TOPIC:该类型与 DIRECT 类型相似,使用 Routing Key 模式匹配和字符串比较的方式将消息路由至绑定的 Queue。

  • FANOUT:该类型路由规则非常简单,会把所有发送到该 Exchange 的消息路由到所有与它绑定的 Queue 中,相当于广播功能。

  • HEADERS:该类型与 DIRECT 类型相似。Headers Exchange 使用 Headers 属性代替 Routing Key 进行路由匹配,在绑定 Headers Exchange 和 Queue 时,设置绑定属性的键值对;在向 Headers Exchange 发送消息时,设置消息的 Headers 属性键值对,使用消息 Headers 属性键值对和绑定属性键值对比较的方式将消息路由至绑定的 Queue。

DIRECT
XDelayedTypestring

x-delayed-message 类型的 Exchange 可以自定义消息的 Header 属性, x-delay 用来指定消息延时投递的时间段,单位为毫秒。该类 Exchange 的路由规则取决于 x-delayed-type 参数中指定的 Exchange 类型,用于指定延迟消息最终将被投递到的实际 Exchange 类型。取值:

  • DIRECT:将延迟消息投递到和 DIRECT 类型 Exchange 绑定的指定队列。

  • TOPIC:将延迟消息投递到和 TOPIC 类型 Exchange 绑定的队列。

  • FANOUT:将延迟消息投递到和 FANOUT 类型 Exchange 绑定的队列。

  • HEADERS:将延迟消息投递到和 HEADERS 类型 Exchange 绑定的队列。

  • X-JMS-TOPIC:将延迟消息投递到和 X-JMS-TOPIC 绑定的队列。

DIRECT
AutoDeleteStateboolean

是否自动删除。取值:

  • true:是。如果绑定到该 Exchange 的最后一个 Queue 解除绑定,该 Exchange 会自动删除。

  • false:否。如果绑定到该 Exchange 的最后一个 Queue 解除绑定,该 Exchange 不会自动删除。

false
Internalboolean

是否为内部 Exchange。取值:

  • false:否

  • true:是

false
AlternateExchangestring

备份 Exchange。配置备份 Exchange 用于接收 Exchange 路由失败的消息。

DemoAE

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

021788F6-E50C-4BD6-9F80-66B0A19A****

示例

正常返回示例

JSON格式

{
  "RequestId": "021788F6-E50C-4BD6-9F80-66B0A19A****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-11OpenAPI 入参发生变更查看变更详情
2024-03-19API 内部配置变更,不影响调用查看变更详情