tencent cloud

All product documents
APIs
DocumentationAPIsApplication Performance ManagementBusiness System APIsModifyApmInstance
ModifyApmInstance
Last updated: 2025-02-25 15:58:07
ModifyApmInstance
Last updated: 2025-02-25 15:58:07

1. API Description

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

This API is used to modify 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: ModifyApmInstance.
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.
Name Yes String Business system name.
Tags.N No Array of ApmTag Tag list.
Description No String Business system description.
TraceDuration No Integer Retention period of trace data (unit: days).
OpenBilling No Boolean Billing switch.
SpanDailyCounters No Integer Business system report limit.
ErrRateThreshold No Integer Error rate warning line. when the average error rate of the application exceeds this threshold, the system will give an abnormal note.
SampleRate No Integer Sampling rate (unit: %).
ErrorSample No Integer Error sampling switch (0: off, 1: on).
SlowRequestSavedThreshold No Integer Sampling slow call saving threshold (unit: ms).
IsRelatedLog No Integer Log feature switch (0: off; 1: on).
LogRegion No String Log region, which takes effect after the log feature is enabled.
LogTopicID No String CLS log topic id, which takes effect after the log feature is enabled.
LogSet No String Logset, which takes effect only after the log feature is enabled.
LogSource No String Log source, which takes effect only after the log feature is enabled.
CustomShowTags.N No Array of String List of custom display tags.
PayMode No Integer Modify billing mode (1: prepaid, 0: pay-as-you-go).
ResponseDurationWarningThreshold No Integer Response time warning line.
Free No Integer Whether it is free (0 = paid edition; 1 = tsf restricted free edition; 2 = free edition), default 0.
IsRelatedDashboard No Integer Whether to associate the dashboard (0 = off, 1 = on).
DashboardTopicID No String Associated dashboard id, which takes effect after the associated dashboard is enabled.
IsSqlInjectionAnalysis No Integer SQL injection detection switch (0: off, 1: on).
IsInstrumentationVulnerabilityScan No Integer Whether to enable component vulnerability detection (0 = no, 1 = yes).

3. Output Parameters

Parameter Name Type Description
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 Cases

This API is used to modify APM business system parameters.

Input Example

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

{
    "InstanceId": "apm-CVfliqa8U",
    "Tags": [],
    "Description": "Test Business System"
    "TraceDuration": 0,
    "Name": "Test Business System"
    "OpenBilling": true,
    "SpanDailyCounters": 1,
    "ErrRateThreshold": 5,
    "SampleRate": 50,
    "ErrorSample": 1,
    "SlowRequestSavedThreshold": 500,
    "IsRelatedLog": 0,
    "LogRegion": "",
    "LogTopicID": "",
    "LogSet": "",
    "LogSource": ""
}

Output Example

{
    "Response": {
        "RequestId": "test-test-test"
    }
}

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
AuthFailure CAM signature/authentication error.
AuthFailure.UnauthorizedOperation AuthFailure.UnauthorizedOperation
DryRunOperation DryRun operation means the request will be successful, but the dryrun parameter is passed.
FailedOperation Operation failed.
FailedOperation.AccessTagFail Tag access failed.
FailedOperation.AppIdNotMatchInstanceInfo The appid does not match the business system information.
FailedOperation.InstanceCannotModify Modification of this business system is not allowed.
FailedOperation.InstanceIdIsEmpty Business system id is empty.
FailedOperation.InstanceNotFound The apm business system does not exist.
FailedOperation.InvalidParam Invalid input parameter.
FailedOperation.InvalidRequest Invalid request.
FailedOperation.SendRequest Failed to send the query request.
InternalError Internal error.
InvalidParameter Parameter error.
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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon