CreateProfileTask

Download PDF

Last updated: 2025-11-14 16:37:48

CreateProfileTask

Last updated: 2025-11-14 16:37:48

Download PDF

1. API Description

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

This API is used to create an event task.

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: CreateProfileTask.
Version	Yes	String	Common Params. The value used for this API: 2021-06-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ServiceName	Yes	String	Application name
InstanceId	Yes	String	APM business system ID.
ServiceInstance	Yes	String	Application instance (online).
Event	Yes	String	Event type (cpu, alloc).
Duration	Yes	Integer	Specifies the task duration in milliseconds (ms). value range: 5 to 180 seconds.
AllTimes	Yes	Integer	Number of execution. value range: 1-100.
StartTime	No	Integer	Start timestamp. 0 indicates start from the current time (unit: seconds).
TaskInterval	No	Integer	Specifies the task execution interval in milliseconds (ms). value range: 10 to 600 seconds. cannot be less than 1.5 times the Duration.

3. Output Parameters

Parameter Name	Type	Description
TaskId	Integer	Task ID
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Successful Example

This example shows you how to successfully complete the operation.

Input Example

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

{
    "ServiceName": "springboot-service",
    "InstanceId": "apm-ewyzCXlxj",
    "ServiceInstance": "127.0.0.1",
    "StartTime": 0,
    "Duration": 5000,
    "Event": "cpu",
    "AllTimes": 1,
    "TaskInterval": 10000
}

Output Example

{
    "Response": {
        "RequestId": "eac7cf53-1900-4367-9076-a5649ddd4dbb",
        "TaskId": 10001
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation	Operation failed.
FailedOperation.AgentNotOnlineError	Probe not detected online.
FailedOperation.AgentVersionNotSupportError	The current agent version does not support this feature.
FailedOperation.InvalidParam	Invalid input parameter.
FailedOperation.InvalidRequest	Invalid request.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud