接口请求域名: apm.intl.tencentcloudapi.com 。
创建事件任务
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateProfileTask。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ServiceName | 是 | String | 应用名称 |
| InstanceId | 是 | String | APM业务系统ID |
| ServiceInstance | 是 | String | 应用实例(在线) |
| Event | 是 | String | 事件类型(cpu、alloc) |
| Duration | 是 | Integer | 任务持续时长(单位:毫秒),范围限制在5~180秒 |
| AllTimes | 是 | Integer | 执行次数,范围限制在1~100次 |
| StartTime | 否 | Integer | 开始时间戳,0代表从当前开始(单位:秒) |
| TaskInterval | 否 | Integer | 任务执行间隔(单位:毫秒),范围限制在10~600秒,不可小于1.5倍的Duration |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 任务ID |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
成功示例
POST / HTTP/1.1
Host: apm.intl.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
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AgentNotOnlineError | 未检测到探针在线 |
| FailedOperation.AgentVersionNotSupportError | 当前探针版本不支持此功能 |
| FailedOperation.InvalidParam | 不合法入参 |
| FailedOperation.InvalidRequest | 不合法请求 |
文档反馈