DescribeApmInstances

Download PDF

Last updated: 2025-02-25 15:58:08

Last updated: 2025-02-25 15:58:08

Download PDF

1. API Description

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

This API is used to obtain the list of APM business systems.

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: DescribeApmInstances.
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.
Tags.N	No	Array of ApmTag	Tag list.
InstanceName	No	String	Filter by business system name.
InstanceIds.N	No	Array of String	Filter by business system id.
DemoInstanceFlag	No	Integer	Whether to query the official demo business system (0 = non-demo business system, 1 = demo business system, default is 0).
AllRegionsFlag	No	Integer	Whether to query all regional business systems (0 = do not query all regions, 1 = query all regions, default is 0).

3. Output Parameters

Parameter Name	Type	Description
Instances	Array of ApmInstanceDetail	APM business system list.
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 Obtain the List Of APM Business Systems

Obtain the list of APM business systems

Input Example

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

{
    "Tags": [
        {
            "Key": "appid",
            "Value": "1231"
        }
    ]
}

Output Example

{
    "Response": {
        "Instances": [
            {
                "Name": "ss1123",
                "InstanceId": "zE7Yu-g7R",
                "Description": "ssd",
                "TraceDuration": 3,
                "AppId": 251005942,
                "CreateUin": "1500000686",
                "Tags": [],
                "ServiceCount": 0,
                "ClientCount": 0,
                "TotalCount": 0,
                "CountOfReportSpanPerDay": 0,
                "AmountOfUsedStorage": 100,
                "Status": 2,
                "Region": "ap-guangzhou",
                "ErrRateThreshold": 5,
                "SampleRate": 100,
                "ErrorSample": 0,
                "SlowRequestSavedThreshold": 500,
                "SpanDailyCounters": 1,
                "BillingInstance": 0,
                "MetricDuration": 30,
                "CustomShowTags": [],
                "PayMode": 1,
                "PayModeEffective": true,
                "LogSource": "",
                "LogRegion": "",
                "IsRelatedLog": 0,
                "LogTopicID": "",
                "LogSet": ""
            }
        ],
        "RequestId": "7uv7qo2mmm1e3ao94113zuvm2sehp7mm"
    }
}

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
AuthFailure.AccessCAMFail	CAM authentication fails.
AuthFailure.UnmarshalResponse	CAM authentication parsing failed.
FailedOperation	Operation failed.
FailedOperation.AccessTagFail	Tag access failed.
FailedOperation.SendRequest	Failed to send the query request.

Was this page helpful?

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

Yes

tencent cloud