CreateApmSampleConfig

Last updated:2025-11-14 16:38:02

CreateApmSampleConfig

Last updated: 2025-11-14 16:38:02

1. API Description

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

Create sampling configurations

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: CreateApmSampleConfig.
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.
InstanceId	Yes	String	Business system ID
SampleRate	Yes	Integer	Sampling rate.
ServiceName	Yes	String	Application name
SampleName	Yes	String	Sampling rule name.
Tags.N	No	Array of APMKVItem	Sampling tags
OperationName	No	String	API name.
OperationType	No	Integer	0: exact match (default); 1: prefix match; 2: suffix match.

3. Output Parameters

Parameter Name	Type	Description
ApmSampleConfig	ApmSampleConfig	Sampling configuration parameter
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 Creating Sampling Configurations

This example shows you how to create a sampling configuration.

Input Example

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

{
    "InstanceId": "apm-ewyzCXlxj",
    "SampleRate": 100,
    "SampleName": "testCreate",
    "ServiceName": "test",
    "OperationName": "1",
    "OperationType": 1
}

Output Example

{
    "Response": {
        "ApmSampleConfig": {
            "Id": 159,
            "InstanceKey": "apm-ewyzCXlxj",
            "OperationName": "1",
            "OperationType": 1,
            "SampleName": "testCreate",
            "SampleRate": 100,
            "ServiceName": "test",
            "SpanNum": 0,
            "Status": 0,
            "Tags": null
        },
        "RequestId": "ba26351b-4ad0-404b-b138-c86e442cabd9"
    }
}

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.DemoInstanceNotAllowModified	Modification to the API is not allowed when the allowlist is not hit and the business system id is the official demo business system id.
FailedOperation.InvalidOperationType	Invalid API match type.
FailedOperation.InvalidParam	Invalid input parameter.
FailedOperation.InvalidRequest	Invalid request.
FailedOperation.OperationNameIsEmpty	API name cannot be empty.
FailedOperation.SampleNameConflict	Duplicate sampling name under this instance.
FailedOperation.SampleRuleConflict	Sampling rule conflict.

Was this page helpful?

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

Yes

Feedback

tencent cloud