tencent cloud

All product documents
APIs
DocumentationAPIsApplication Performance ManagementBusiness System APIsCreateApmInstance
CreateApmInstance
Last updated: 2025-02-25 15:58:11
CreateApmInstance
Last updated: 2025-02-25 15:58:11

1. API Description

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

This API is used to create a business purchase in the APM business system.

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: CreateApmInstance.
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.
Name Yes String Business system name.
Description No String Business system description information.
TraceDuration No Integer Retention period of trace data (unit: days, the default storage duration is 3 days).
Tags.N No Array of ApmTag Business system tag list.
SpanDailyCounters No Integer The report quota value of the business system. the default value is 0, indicating no limit on the report quota. (obsolete).
PayMode No Integer Billing model of the business system (0: pay-as-you-go, 1: prepaid).
Free No Integer Whether it is a free edition business system (0 = paid edition; 1 = tsf restricted free edition; 2 = free edition).

3. Output Parameters

Parameter Name Type Description
InstanceId String Business system 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 Create an APM Business System

Create an APM business system

Input Example

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

{
    "Name": "Observability-Test"
    "Description": "Testing environment"
    "Tags": [
        {
            "Key": "appid",
            "Value": "123123422"
        }
    ]
}

Output Example

{
    "Response": {
        "InstanceId": "apm-CVfliqa8U",
        "RequestId": "49fktc24elkfi4a1mkyir-9t2pt2stlx"
    }
}

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

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.InvalidParam Invalid input parameter.
FailedOperation.InvalidRequest Invalid request.
FailedOperation.RegionNotSupport This region is not supported.
FailedOperation.SendRequest Failed to send the query request.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support