Application Performance Management
- Purchase Guide
- Pay-as-you-go (Postpaid)
- Packages (Prepaid)
- Operation Guide
- Resource Management
- Application Monitoring
- Tracing
- Database Call Monitoring
- Access Management
- Alarm Service
- System Configuration
- Practical Tutorial
- Access Guide
- Accessing Go Application
- Accessing Java Application
- Accessing Python Application
- Accessing Node.js Application
- Accessing PHP Application
- Accessing .NET Application
- Parameter Information
- Frameworks and Components Supported by SkyWalking
- API Documentation
- Making API Requests
- Application APIs
- Business System APIs
- General Query APIs
- Service Agreement
DocumentationApplication Performance ManagementAPI DocumentationApplication APIsDescribeGeneralApmApplicationConfig
DescribeGeneralApmApplicationConfig
Last updated: 2025-02-25 15:58:16
1. API Description
Domain name for API request: apm.intl.tencentcloudapi.com.
This API is used to query the application configuration information.
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: DescribeGeneralApmApplicationConfig. |
| 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 | Business system id. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ApmApplicationConfigView | ApmApplicationConfigView | Application configuration item. |
| 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 This API Is Used To Query the Application Configuration Information
This API is used to query the configuration information of applications under the specified business system.
Input Example
POST / HTTP/1.1
Host: apm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralApmApplicationConfig
<Common request parameters>
{
"InstanceId": "apm-6xYKFXYxo",
"ServiceName": "java-order-service"
}
Output Example
{
"Response": {
"ApmApplicationConfigView": {
"InstanceKey": "apm-059oXBfTL",
"ServiceName": "profile-service",
"OperationNameFilter": "",
"ExceptionFilter": "",
"ErrorCodeFilter": "",
"EventEnable": false,
"UrlConvergenceSwitch": 1,
"UrlConvergenceThreshold": 500,
"UrlConvergence": "RPCServer/market.MarketService2/(.*?)",
"UrlExclude": "",
"IsRelatedLog": 0,
"LogSource": "CLS",
"LogSet": "",
"LogTopicID": "",
"SnapshotEnable": true,
"SnapshotTimeout": 2000,
"AgentEnable": true,
"InstrumentList": [
{
"Name": "dubbo",
"Enable": true
},
{
"Name": "googlehttpclient",
"Enable": true
},
{
"Name": "grpc",
"Enable": true
},
{
"Name": "httpclient3",
"Enable": true
},
{
"Name": "httpclient4",
"Enable": true
},
{
"Name": "hystrix",
"Enable": true
},
{
"Name": "lettuce",
"Enable": true
},
{
"Name": "mongodb",
"Enable": true
},
{
"Name": "mybatis",
"Enable": true
},
{
"Name": "mysql",
"Enable": true
},
{
"Name": "okhttp",
"Enable": true
},
{
"Name": "redis",
"Enable": true
},
{
"Name": "rxjava",
"Enable": true
},
{
"Name": "spring-webmvc",
"Enable": true
},
{
"Name": "tomcat",
"Enable": true
}
],
"TraceSquash": true
},
"RequestId": "test-test-test0980990"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.AppIdNotMatchInstanceInfo | The appid does not match the business system information. |
| FailedOperation.InstanceNotFound | The apm business system does not exist. |
| FailedOperation.InvalidServiceName | Business system and application name do not match. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No