1. 接口描述
接口请求域名： apm.tencentcloudapi.com 。
创建事件任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateProfileTask。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ServiceName | 是 | String | 应用名称 示例值：springboot-service |
| InstanceId | 是 | String | APM业务系统ID 示例值：apm-eQls4MGPr |
| ServiceInstance | 是 | String | 应用实例（在线） 示例值：127.0.0.1 |
| Event | 是 | String | 事件类型（cpu、alloc） 示例值：cpu |
| Duration | 是 | Integer | 任务持续时长(单位：毫秒)，范围限制在5~180秒 示例值：5000 |
| AllTimes | 是 | Integer | 执行次数，范围限制在1~100次 示例值：1 |
| StartTime | 否 | Integer | 开始时间戳，0代表从当前开始(单位：秒) 示例值：0 |
| TaskInterval | 否 | Integer | 任务执行间隔(单位：毫秒)，范围限制在10~600秒，不可小于1.5倍的Duration 示例值：5000 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 任务ID 示例值：100001 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功示例
成功示例
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProfileTask
<公共请求参数>
{
"ServiceName": "springboot-service",
"InstanceId": "apm-ewyzCXlxj",
"ServiceInstance": "127.0.0.1",
"StartTime": 0,
"Duration": 5000,
"Event": "cpu",
"AllTimes": 1,
"TaskInterval": 10000
}输出示例
{
"Response": {
"RequestId": "eac7cf53-1900-4367-9076-a5649ddd4dbb",
"TaskId": 10001
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AgentNotOnlineError | 未检测到探针在线 |
| FailedOperation.AgentVersionNotSupportError | 当前探针版本不支持此功能 |
| FailedOperation.InvalidParam | 不合法入参 |
| FailedOperation.InvalidRequest | 不合法请求 |
