有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: eb.tencentcloudapi.com 。

创建事件目标

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTarget。
Version String 公共参数,本接口取值:2021-04-16。
Region String 公共参数,详见产品支持的 地域列表
EventBusId String 事件集ID
示例值:eb-xxxxxxxx
Type String 目标类型;取值范围:scf(云函数)/cls(日志服务)/amp(消息推送)/ckafka(消息推送)/es(大数据elastic-search)
示例值:scf
TargetDescription TargetDescription 目标描述;scf类型示例:
{"ResourceDescription":"qcs::scf:ap-guangzhou:uin/2252646423:namespace/default/function/john-test-0326/$LATEST"};
cls类型示例:
{"ResourceDescription":"qcs::cls:ap-guangzhou:uin/12323442323:topic/7103f705-6c38-4b64-ac9d-428af0f2e732"}
ckafka类型示例:
{"ResourceDescription":"qcs::ckafka:ap-guangzhou:uin/1500000688:ckafkaId/uin/1500000688/ckafka-018q1nwj","CkafkaTargetParams":{"TopicName":"alert","RetryPolicy":{"RetryInterval":60,"MaxRetryAttempts":360}}}
amp类型-邮件/短信示例:
{"ResourceDescription":"qcs::eb-amp:ap-guangzhou:uin/100012505002:","AMPParams":{"NotificationTemplateId":10181,"Lang":"cn","NoticeReceivers":[{"UserType":"User","UserIds":["9424525"],"TimeWindow":{"From":"09:30:00","To":"23:30:00"},"Channels":["Email","SMS"]}]}}
es类型示例:
{"ResourceDescription":"qcs::es:ap-guangzhou:uin/1500000688:instance/es-7cplmhsd","ESTargetParams":{"EsVersion":"7.14.2","UserName":"elastic","Password":"xxxxx","NetMode":"privateLink","IndexPrefix":"auto-test","IndexSuffixMode":"default","RotationInterval":"none","IndexTemplateType":"","OutputMode":"default"}}
示例值:{"ResourceDescription":"qcs::scf:ap-guangzhou:uin/2252646423:namespace/default/function/john-test-0326/$LATEST"}
RuleId String 事件规则ID
示例值:rule-xxxxxxxx

3. 输出参数

参数名称 类型 描述
TargetId String 目标ID
示例值:target-e9r3a1l0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建目标

输入示例

POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTarget
<公共请求参数>

{
    "EventBusId": "eb-xxxxxx",
    "Type": "scf",
    "TargetDescription": {
        "ResourceDescription": "qcs::scf:ap-guangzhou:uin/xxxxxxxx:namespace/xxxxxx/function/xxxxx/x"
    },
    "RuleId": "rule-xxxxxxx"
}

输出示例

{
    "Response": {
        "RequestId": "b7662cf2-ce20-4b3e-aff2-2cb875cf0b6b",
        "TargetId": "target-xxxxxx"
    }
}

示例2 创建自定义投递目标

输入示例

POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTarget
<公共请求参数>

{
    "EventBusId": "eb-xxxxxx",
    "Type": "scf",
    "TargetDescription": {
        "ResourceDescription": "qcs::custom_scf:ap-guangzhou:appid/xxxxx/uin/xxxxxxxx:namespace/xxxxxx/function/xxxxx/x"
    },
    "RuleId": "rule-xxxxxxx"
}

输出示例

{
    "Response": {
        "TargetId": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.AddPrivateLink 添加私有链接失败。
FailedOperation.AuthenticateUserFailed 用户鉴权错误。
FailedOperation.CreateTrigger 投递目标创建失败,请检查函数状态。
FailedOperation.ESInternalError ES集群内部错误。
FailedOperation.ESRequestFailed ES集群操作失败。
FailedOperation.ESTemplateConflict ES索引模板冲突错误。
InvalidParameter.Payload Payload与规范不符,请修正后再试。
InvalidParameterValue.AMPParams AMPParams取值与规范不符,请修正后再试。
InvalidParameterValue.BatchEventCount BatchEventCount取值与规范不符,请修正后再试。
InvalidParameterValue.BatchTimeout BatchTimeout取值与规范不符,请修正后再试。
InvalidParameterValue.CKafkaTargetParams Ckafka 目标配置参数取值与规范不符,请修正后再试。
InvalidParameterValue.CallbackType CallbackType取值与规范不符,请修正后再试。
InvalidParameterValue.CallbackWeComURL CallbackWeComURL取值与规范不符,请修正后再试。
InvalidParameterValue.ElasticSearchTargetParams ES目标参数错误。
InvalidParameterValue.EventBusId EventBusId取值与规范不符,请修正后再试。
InvalidParameterValue.NoticeReceiverChannel NoticeReceiverChannel取值与规范不符,请修正后再试。
InvalidParameterValue.NoticeReceiverTimeWindow NoticeReceiverTimeWindow取值与规范不符,请修正后再试。
InvalidParameterValue.NoticeReceiverUserIds NoticeReceiverUserIds取值与规范不符,请修正后再试。
InvalidParameterValue.NoticeReceiverUserType NoticeReceiverUserType取值与规范不符,请修正后再试。
InvalidParameterValue.Qualifier Qualifier取值与规范不符,请修正后再试。
InvalidParameterValue.RuleId RuleId取值与规范不符,请修正后再试。
InvalidParameterValue.TargetDescription TargetDescription取值与规范不符,请修正后再试。
InvalidParameterValue.Type Type取值与规范不符,请修正后再试。
LimitExceeded.ClusterPrivateLinkExceeded 集群私有链接超限。
LimitExceeded.Logset Logset数量达到限制,可提交工单申请提升限制。
LimitExceeded.Target Target数量达到限制,可提交工单申请提升限制。
LimitExceeded.Trigger 投递目标创建失败,函数触发器数量达到限制,可提交工单申请提升限制。
LimitExceeded.UserPrivateLinkExceeded 用户私有链接超限。
OperationDenied.AccountNotExists 投递目标创建失败,检测到当前账号不存在,请确认您的账号状态。
OperationDenied.DefaultCLSResourceUnsupported 不允许在自定义事件集上创建基于EB默认日志集的CLS事件目标。
OperationDenied.ESVersionUnsupported 不支持操作当前ES版本。
OperationDenied.EventBusResourceIsLocked 技术架构升级,该资源临时锁定中,预计持续3~5分钟,事件推送流程无影响。
OperationDenied.UnsupportedOperation 当前用户账号类型暂不支持操作,请提交工单处理。
ResourceNotFound.EventBus 未找到指定事件集,请创建后再试。
ResourceNotFound.Function 未找到指定的Function,请创建后再试。
ResourceNotFound.Namespace 投递目标创建失败,未找到指定的命名空间,请创建后再试。
ResourceNotFound.PrivateLinkResource 未找到privatelink记录。
ResourceNotFound.Role 未找到指定的服务角色,请创建后再试。
ResourceNotFound.Rule 未找到指定的Rule,请创建后再试。
ResourceNotFound.Target 未找到指定的Target,请创建后再试。
ResourceNotFound.Version 投递目标创建失败,未找到指定的服务版本,请创建后再试。
ResourceUnavailable.ESUnhealth ES集群状态异常。
ResourceUnavailable.Target 投递目标创建失败,当前资源不可用。