管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>应用性能监控>业务系统相关接口>获取 APM 业务系统列表

获取 APM 业务系统列表

最近更新时间：2025-06-09 01:09:00

我的收藏

本页目录：

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 列表
示例值：[{ "Key": "AppId", "Value": "123123422" }]
InstanceName 否 String 按业务系统名过滤，支持模糊检索
示例值：可观测-测试
InstanceId 否 String 按业务系统 ID 过滤，支持模糊检索
示例值：apm-CVfliqa8U
InstanceIds.N 否 Array of String 按业务系统 ID 过滤
示例值：[ "apm-CVfliqa8U", "apm-059oXBfTL" ]
DemoInstanceFlag 否 Integer 是否查询官方 Demo 业务系统（0=非 Demo 业务系统，1=Demo 业务系统，默认为0）
示例值：0
AllRegionsFlag 否 Integer 是否查询全地域业务系统（0=不查询全地域，1=查询全地域，默认为0）
示例值：1

3. 输出参数

参数名称 类型 描述
Instances Array of ApmInstanceDetail APM 业务系统列表
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": "251005942"
        }
    ]
}

输出示例

{
    "Response": {
        "Instances": [
            {
                "AmountOfUsedStorage": 100,
                "AppId": 251005942,
                "BillingInstance": 0,
                "ClientCount": 0,
                "CountOfReportSpanPerDay": 0,
                "CreateUin": "1500000686",
                "CustomShowTags": [],
                "DashboardTopicID": "",
                "DefaultTSF": 0,
                "Description": "",
                "ErrRateThreshold": 5,
                "ErrorSample": 1,
                "Free": 2,
                "InstanceId": "apm-u6HNYVXhz",
                "IsInstrumentationVulnerabilityScan": 1,
                "IsMemoryHijackingAnalysis": 1,
                "IsRelatedDashboard": 0,
                "IsRelatedLog": 0,
                "IsRemoteCommandExecutionAnalysis": 1,
                "IsSqlInjectionAnalysis": 1,
                "LogIndexType": 0,
                "LogRegion": "",
                "LogSet": "",
                "LogSource": "",
                "LogTopicID": "",
                "LogTraceIdKey": "",
                "MetricDuration": 3,
                "Name": "test1",
                "PayMode": 0,
                "PayModeEffective": true,
                "Region": "ap-guangzhou",
                "ResponseDurationWarningThreshold": 500,
                "SampleRate": 100,
                "ServiceCount": 0,
                "SlowRequestSavedThreshold": 500,
                "SpanDailyCounters": 0,
                "Status": 1,
                "StopReason": 0,
                "Tags": [
                    {
                        "Key": "负责人",
                        "Value": "archerkang"
                    },
                    {
                        "Key": "运营产品",
                        "Value": "云监控产品"
                    },
                    {
                        "Key": "运营部门",
                        "Value": "/../../../../../../../../../../../../../../../../../../../../etc/./////.////.///.//./passwd"
                    }
                ],
                "TotalCount": 0,
                "TraceDuration": 7
            }
        ],
        "RequestId": "1afaff9e-88c9-4949-9c84-fd5eae88a88a"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.AccessCAMFail CAM鉴权失败
AuthFailure.UnmarshalResponse CAM鉴权解析失败
FailedOperation 操作失败。
FailedOperation.AccessTagFail 访问标签失败。
FailedOperation.SendRequest 发送查询请求失败。
中国站
目录