1. 接口描述
接口请求域名： apm.tencentcloudapi.com 。
修改采样配置接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyApmSampleConfig。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 业务系统ID 示例值：apm-1o8yMC47u |
| SampleName | 是 | String | 采样规则名 示例值：testSample |
| SampleRate | 是 | Integer | 采样率 示例值：95 |
| ServiceName | 否 | String | 应用名，生效于所有应用则填空 示例值：java-market-service |
| OperationName | 否 | String | 接口名 示例值：/test |
| Tags.N | 否 | Array of APMKVItem | 采样tag |
| Status | 否 | Integer | 采样开关 0关 1开 2删除 示例值：1 |
| Id | 否 | Integer | 配置Id 示例值：1 |
| OperationType | 否 | Integer | 0=精确匹配（默认）；1=前缀匹配；2=后缀匹配 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改采样配置
修改采样配置
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApmSampleConfig
<公共请求参数>
{
"InstanceId": "apm-ewyzCXlxj",
"SampleName": "testSample",
"SampleRate": 100,
"ServiceName": "",
"OperationName": "2",
"Tags": [],
"Status": 0,
"Id": 156,
"OperationType": 0
}输出示例
{
"Response": {
"RequestId": "f678ef4b-9947-4ec0-99b8-1e6bc8b8e477"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InvalidOperationType | 不合法的接口匹配类型 |
| FailedOperation.InvalidParam | 不合法入参 |
| FailedOperation.InvalidRequest | 不合法请求 |
| FailedOperation.OperationNameIsEmpty | 接口名不能为空 |
| FailedOperation.SampleRuleConflict | 采样规则冲突。 |
