tencent cloud

APIs

创建 APM 业务系统

Download
聚焦模式
字号
最后更新时间: 2026-05-14 20:28:58

1. 接口描述

接口请求域名: apm.intl.tencentcloudapi.com 。

业务购买 APM 业务系统,调用该接口创建

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateApmInstance。
Version String 公共参数,本接口取值:2021-06-22。
Region String 公共参数,详见产品支持的 地域列表
Name String 业务系统名
Description String 业务系统描述信息
TraceDuration Integer Trace 数据保存时长(单位:天,默认存储时长为3天)
Tags.N Array of ApmTag 业务系统 Tag 列表
SpanDailyCounters Integer 业务系统上报额度值,默认赋值为0表示不限制上报额度,已废弃
PayMode Integer 业务系统的计费模式(0=按量付费,1=预付费)
Free Integer 是否为免费版业务系统(0=付费版;1=TSF 受限免费版;2=免费版)

3. 输出参数

参数名称 类型 描述
InstanceId String 业务系统 ID
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建 APM 业务系统

创建 APM 业务系统

输入示例

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

{
    "Name": "可观测-测试",
    "Description": "测试环境",
    "Tags": [
        {
            "Key": "appid",
            "Value": "123123422"
        }
    ]
}

输出示例

{
    "Response": {
        "InstanceId": "apm-CVfliqa8U",
        "RequestId": "49fktc24elkfi4a1mkyir-9t2pt2stlx"
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidParam 不合法入参
FailedOperation.InvalidRequest 不合法请求
FailedOperation.RegionNotSupport 不支持该地域。
FailedOperation.SendRequest 发送查询请求失败。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈