ListTargets - 查询一个事件规则的所有投递目标

查询一个事件规则的所有投递目标。

调试

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

授权信息

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

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

请求参数

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

事件总线的名称。

my-event-bus
Limitinteger

限定每次返回的最大条数。

10
RuleNamestring

事件规则名称。

tf-testacc-rule
NextTokenstring

当指定 Limit 时,如果还有多余的返回值则会返回 NextToken。

0
Arnstring

ARN 资源描述。

acs:fc:cn-hangzhou:118609547428****:services/fc-connector.a1/functions/event

返回参数

名称类型描述示例值
object
Messagestring

错误信息。

EventRuleNotExisted
RequestIdstring

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

5DAF96FB-A4B6-548C-B999-0BFDCB22****
Dataobject

返回结果。

Targetsarray<object>

事件目标。

Targetsobject

目标 target

Typestring

事件目标类型。更多信息,请参见事件目标参数

acs.fc.function
Endpointstring

投递端点链接。

acs:fc:cn-hangzhou:123456789098****:services/guide.LATEST/functions/HelloFC
ParamListarray<object>

事件目标的参数。

ParamListobject

事件目标的参数。

Valuestring

事件目标参数的值。

{\"key\"=\"value\"}
Templatestring

事件目标参数模板样式。

The value of ${key} is ${value}!
Formstring

事件目标参数的格式。

TEMPLATE
ResourceKeystring

事件目标的资源参数。

body
ErrorsTolerancestring

容错策略。取值说明如下: ALL:允许容错。允许异常容错,当异常发生时不会阻塞执行,超过重试策略后会根据配置将消息投递至死信队列或直接丢弃。 NONE:禁止容错。不允许容错,当异常发生并超过重试策略配置时会阻塞执行。

ALL
Idstring

事件目标 ID。

1453
EventBusNamestring

事件总线的名称。

sls-beijing-one1-tf
RuleNamestring

事件规则的名称。

rule-uKAK2
NextTokenstring

如果还有多余的返回值则会返回 NextToken。

1
Totalinteger

总条数。

18
Codestring

接口返回码:

  • Success:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码。
Success
Successboolean

请求是否成功,返回值如下:

  • true:请求成功。
  • false:请求失败。
true

示例

正常返回示例

JSON格式

{
  "Message": "EventRuleNotExisted",
  "RequestId": "5DAF96FB-A4B6-548C-B999-0BFDCB22****",
  "Data": {
    "Targets": [
      {
        "Type": "acs.fc.function ",
        "Endpoint": "acs:fc:cn-hangzhou:123456789098****:services/guide.LATEST/functions/HelloFC ",
        "ParamList": [
          {
            "Value": "{\\\"key\\\"=\\\"value\\\"}",
            "Template": "The value of ${key} is ${value}! ",
            "Form": "TEMPLATE",
            "ResourceKey": "body"
          }
        ],
        "ErrorsTolerance": "ALL",
        "Id": "1453",
        "EventBusName": "sls-beijing-one1-tf",
        "RuleName": "rule-uKAK2",
        "ConcurrentConfig": {
          "Concurrency": 0
        }
      }
    ],
    "NextToken": "1",
    "Total": 18
  },
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code错误码错误信息
403ServiceNotEnableService not enable

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

变更历史

变更时间变更内容概要操作
2024-09-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-06-09OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情