应用性能监控
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 应用性能监控

拉取APM实例列表

最近更新时间：2024-03-12 01:09:08

我的收藏

本页目录：

1. 接口描述

接口请求域名： apm.tencentcloudapi.com 。

APM实例列表拉取

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeApmInstances。
Version 是 String 公共参数，本接口取值：2021-06-22。
Region 是 String 公共参数，详见产品支持的 地域列表。
Tags.N 否 Array of ApmTag Tag列表
InstanceName 否 String 搜索实例名
示例值：云监控-测试
InstanceIds.N 否 Array of String 过滤实例ID
DemoInstanceFlag 否 Integer 是否查询官方demo实例
AllRegionsFlag 否 Integer 是否查询全地域实例
示例值：1

3. 输出参数

参数名称 类型 描述
Instances Array of ApmInstanceDetail apm实例列表
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 拉取APM实例列表

拉取APM实例列表

输入示例

POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApmInstances
<公共请求参数>

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

输出示例

{
    "Response": {
        "Instances": [
            {
                "Name": "APM自动化测试",
                "InstanceId": "apm-OzNrwxuDj",
                "Description": "test123",
                "TraceDuration": 1,
                "AppId": 251226959,
                "CreateUin": "700000357122",
                "Tags": [
                    {
                        "Key": "AutoTest",
                        "Value": "cvm"
                    }
                ],
                "ServiceCount": 5,
                "ClientCount": 5,
                "TotalCount": 0,
                "CountOfReportSpanPerDay": 0,
                "AmountOfUsedStorage": 100,
                "Status": 2,
                "Region": "ap-guangzhou",
                "ErrRateThreshold": 5,
                "SampleRate": 100,
                "ErrorSample": 1,
                "SlowRequestSavedThreshold": 500,
                "SpanDailyCounters": 0,
                "BillingInstance": 1,
                "MetricDuration": 30,
                "LogSource": "",
                "LogRegion": "",
                "IsRelatedLog": 0,
                "LogTopicID": "",
                "LogSet": ""
            }
        ],
        "RequestId": "7uv7qo2mmm1e3ao94113zuvm2sehp7mm"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
FailedOperation.AccessTagFail 访问标签失败。
FailedOperation.SendRequest 发送查询请求失败。
中国站