tencent cloud

事件总线

动态与公告
产品动态
【2024年07月19日】CLS 的 EB 专用日志主题恢复计费公告
新手指引
产品简介
产品概述
基本概念
产品优势
应用场景
限制说明
购买指南
计费概述
产品定价
欠费与停服说明
快速入门
开通事件总线
快速投递自定义事件
快速配置云产品事件告警推送
快速配置云监控事件告警推送
事件源
事件源概述
官方云服务事件源
事件结构
连接器
事件
事件结构
自定义事件
官方云服务事件
事件集
事件集概述
创建事件集
管理事件集
链路追踪
事件规则
事件规则概述
事件模式
创建事件规则
管理事件规则
配置数据转换
事件目标
SCF 云函数目标
CLS 日志目标
消息推送目标
Ckafka 目标
实践教程
迁移事件告警
Oceanus 告警消息实时推送
云服务器异常自动备份与重启
基于 EventBridge 设计零售业务中台
API 文档
History
Introduction
API Category
Making API Requests
Delivery Target APIs
Event Bus APIs
Event Rule APIs
Event Connector APIs
Data Transformer APIs
Event Storage APIs
Data Types
Error Codes
常见问题
概念相关
告警相关
计费相关
联系我们
EB 政策
EB 隐私协议
EB 数据处理和安全协议

ListTargets

PDF
聚焦模式
字号
最后更新时间: 2025-11-13 20:52:41

1. API Description

Domain name for API request: eb.intl.tencentcloudapi.com.

This API is used to get the list delivery targets.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ListTargets.
Version Yes String Common Params. The value used for this API: 2021-04-16.
Region No String Common Params. This parameter is not required for this API.
RuleId Yes String Event rule ID
EventBusId Yes String Event bus ID
OrderBy No String Indicates by which field to sort the returned results. Valid values: AddTime (creation time), ModTime (modification time)
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
Offset No Integer Pagination offset. Default value: 0.
Order No String Indicates whether the returned results are sorted in ascending or descending order. Valid values: ASC (ascending order), DESC (descending order)

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of targets
Targets Array of Target Target information
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the List of Targets

Input Example

POST / HTTP/1.1
Host: eb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListTargets
<Common request parameters>

{
    "EventBusId": "eb-l65vlc2",
    "RuleId": "rule-fdltium8"
}

Output Example

{
    "Response": {
        "RequestId": "03118ade-8de2-4514-af4b-b9a2f170ddd9",
        "Targets": [
            {
                "EventBusId": "eb-l65vlc2u",
                "RuleId": "rule-fdltium8",
                "TargetDescription": {
                    "ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
                },
                "TargetId": "target-azwj7s7g",
                "Type": "scf",
                "EnableBatchDelivery": false,
                "BatchEventCount": 1,
                "BatchTimeout": 1
            },
            {
                "EventBusId": "eb-l65vlc2u",
                "RuleId": "rule-fdltium8",
                "TargetDescription": {
                    "ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
                },
                "TargetId": "target-o5yx01oq",
                "Type": "scf",
                "EnableBatchDelivery": false,
                "BatchEventCount": 1,
                "BatchTimeout": 1
            },
            {
                "EventBusId": "eb-l65vlc2u",
                "RuleId": "rule-fdltium8",
                "TargetDescription": {
                    "ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
                },
                "TargetId": "target-prp1ovqi",
                "Type": "scf",
                "EnableBatchDelivery": false,
                "BatchEventCount": 1,
                "BatchTimeout": 1
            },
            {
                "EventBusId": "eb-l65vlc2u",
                "RuleId": "rule-fdltium8",
                "TargetDescription": {
                    "ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
                },
                "TargetId": "target-krcwchke",
                "Type": "scf",
                "EnableBatchDelivery": false,
                "BatchEventCount": 1,
                "BatchTimeout": 1
            },
            {
                "EventBusId": "eb-l65vlc2u",
                "RuleId": "rule-fdltium8",
                "TargetDescription": {
                    "ResourceDescription": "qcs::scf:ap-guanzhou:uin/3473058547:namespace/default/function/test/1"
                },
                "TargetId": "target-e9r3a1l0",
                "Type": "scf",
                "EnableBatchDelivery": false,
                "BatchEventCount": 1,
                "BatchTimeout": 1
            }
        ],
        "TotalCount": 5
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue.EventBusId The EventBusId value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.Limit The Limit value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.Offset The Offset value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.Order The Order value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.OrderBy The OrderBy value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.RuleId The RuleId value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.TargetId The TargetId value does not conform to the specification. Please fix it and try again.
ResourceNotFound The resource does not exist.
ResourceNotFound.EventBus The specified event bus was not found. Please create it and try again.
ResourceNotFound.Rule The specified Rule was not found. Please create it and try again.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈