1. 接口描述
接口请求域名: eb.tencentcloudapi.com 。
获取平台产品事件模板
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetPlatformEventTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EventType | 是 | String | 平台产品事件类型 示例值:eb_platform_test:TEST:ALL,此值根据ListPlatformEventNames接口获取 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EventTemplate | String | 平台产品事件模板 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取平台产品事件模板
输入示例
POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetPlatformEventTemplate
<公共请求参数>
{
"EventType": "eb_platform_test:TEST:ALL"
}
输出示例
{
"Response": {
"EventTemplate": "{\n\t\t\t\t\t\"specversion\": \"1.0\",\n\t\t\t\t\t\"id\": \"752e37c8-3528-47f1-8311-98c01e2e89c4\",\n\t\t\t\t\t\"source\": \"platform.cloud.tencent\",\n\t\t\t\t\t\"type\": \"eb_platform_test:TEST:ALL\",\n\t\t\t\t\t\"subject\": \"ins-xxxx\",\n\t\t\t\t\t\"time\": 1693986756,\n\t\t\t\t\t\"region\": \"ap-guangzhou\",\n\t\t\t\t\t\"datacontenttype\": \"application/json;charset=utf-8\",\n\t\t\t\t\t\"tags\": {\n\t\t\t\t\t \"key1\": \"value1\",\n\t\t\t\t\t \"key2\": \"value2\"\n\t\t\t\t\t},\n\t\t\t\t\t\"data\": {\n\t\t\t\t\t \"appId\": 1253970226,\n\t\t\t\t\t \"requestID\": \"xxxxxxxx\",\n\t\t\t\t\t \"errorCode\": \"0\",\n\t\t\t\t\t \"errorMessage\": \"permission verify\",\n\t\t\t\t\t \"actionType\": \"Write\"\n\t\t\t\t\t}\n\t\t\t\t }",
"RequestId": "d8078f15-962d-4407-a4dc-dec4676a9c03"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameterValue.Action | Action 操作参数取值与规范不符,请修正后再试。 |