tencent cloud

All product documents
Application Performance Management
DocumentationApplication Performance ManagementAPI DocumentationBusiness System APIsDescribeApmAgent
DescribeApmAgent
Download PDF
Last updated: 2025-02-25 15:58:10
DescribeApmAgent
Last updated: 2025-02-25 15:58:10
Download PDF

1. API Description

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

Obtaining APM Access Point.

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: DescribeApmAgent.
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.
AgentType No String Access method: currently supports access and reporting via skywalking, ot, and ebpf methods. if not specified, ot is used by default.
NetworkMode No String Reporting environment: currently supports pl (private network reporting), public (public network), and inner (self-developed vpc) environment reporting. if not specified, the default is public.
LanguageEnvironment No String Language reporting is now supported for java, golang, php, python, dotnet, nodejs. if not specified, golang is used by default.
ReportMethod No String Reporting method, deprecated.

3. Output Parameters

Parameter Name Type Description
ApmAgent ApmAgentInfo Agent information.
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 Obtaining APM Access Point

Example of Obtaining APM Access Point

Input Example

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

{
    "InstanceId": "jYm6_leMg"
}

Output Example

{
    "Response": {
        "ApmAgent": {
            "CollectorURL": "http://127.0.0.1:8080",
            "AgentDownloadURL": "https://agent.tapm.tencentyun.com/DownloadAgent",
            "Token": "14dac76ca10f4610f727ca68528758b43980251387493706d18988fa7d0621b7",
            "PublicCollectorURL": "http://127.0.0.1:8080",
            "InnerCollectorURL": "http://127.0.0.1:8080",
            "PrivateLinkCollectorURL": "http://127.0.0.1:8080"
        },
        "RequestId": "mzltx5whme-zl7je3p16tk5fwtb7ht61"
    }
}

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
FailedOperation Operation failed.
FailedOperation.AppIdNotMatchInstanceInfo The appid does not match the business system information.
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.InstanceIdIsEmpty Business system id is empty.
FailedOperation.InstanceNotFound The apm business system does not exist.
FailedOperation.NotInnerVPC Non-Private vpc.
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