应用性能监控创建采样配置

1. 接口描述

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

创建采样配置接口

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateApmSampleConfig。
Version	是	String	公共参数，本接口取值：2021-06-22。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	业务系统ID 示例值：apm-1o8yMC47u
SampleRate	是	Integer	采样率示例值：95
ServiceName	是	String	应用名示例值：java-order-service
SampleName	是	String	采样规则名示例值：testSample
Tags.N	否	Array of APMKVItem	采样Tags
OperationName	否	String	接口名示例值：/stock/get/1
OperationType	否	Integer	0=精确匹配（默认）；1=前缀匹配；2=后缀匹配示例值：0

3. 输出参数

参数名称	类型	描述
ApmSampleConfig	ApmSampleConfig	采样配置参数
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建采样配置

为指定服务的指定接口配置全采样

输入示例

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

{
    "InstanceId": "apm-eDyXPD6FF",
    "SampleRate": 100,
    "ServiceName": "java-order-service",
    "SampleName": "CreateOrderInterfaceAllSample",
    "OperationName": "/order/create",
    "OperationType": 0
}

输出示例

{
    "Response": {
        "ApmSampleConfig": {
            "Id": 2147483657,
            "InstanceKey": "apm-eDyXPD6FF",
            "OperationName": "/order/create",
            "OperationType": 0,
            "SampleName": "CreateOrderInterfaceAllSample",
            "SampleRate": 100,
            "ServiceName": "java-order-service",
            "SpanNum": 0,
            "Status": 0,
            "Tags": null
        },
        "RequestId": "d8ac7f32-6e9c-4eaf-9b76-b388df988b36"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DemoInstanceNotAllowModified	未命中白名单且业务系统 ID 为官方 Demo 业务系统 ID 时，不允许修改接口。
FailedOperation.InvalidOperationType	不合法的接口匹配类型
FailedOperation.InvalidParam	不合法入参
FailedOperation.InvalidRequest	不合法请求
FailedOperation.OperationNameIsEmpty	接口名不能为空
FailedOperation.SampleNameConflict	该实例下采样名重复。
FailedOperation.SampleRuleConflict	采样规则冲突。

创建采样配置

本页目录：