1. 接口描述
接口请求域名： apm.tencentcloudapi.com 。
修改APM实例接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyApmInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：6Dxp7Nd0B |
| Name | 是 | String | 实例名 示例值：云监控-测试 |
| Tags.N | 否 | Array of ApmTag | 标签列表 |
| Description | 否 | String | 实例详情 |
| TraceDuration | 否 | Integer | Trace数据保存时长 示例值：604800 |
| OpenBilling | 否 | Boolean | 是否开启计费 示例值：true |
| SpanDailyCounters | 否 | Integer | 实例上报额度 示例值：10000000 |
| ErrRateThreshold | 否 | Integer | 错误率阈值 示例值：11 |
| SampleRate | 否 | Integer | 采样率 示例值：11 |
| ErrorSample | 否 | Integer | 是否开启错误采样 0 关 1 开 示例值：10 |
| SlowRequestSavedThreshold | 否 | Integer | 慢请求阈值 示例值：500 |
| IsRelatedLog | 否 | Integer | 是否开启日志功能 0 关 1 开 示例值：0 |
| LogRegion | 否 | String | 日志地域 示例值：ap-guangzhou |
| LogTopicID | 否 | String | CLS日志主题ID | ES 索引名 示例值：xxxxx |
| LogSet | 否 | String | CLS日志集 | ES集群ID 示例值：xxxxx |
| LogSource | 否 | String | CLS | ES 示例值：CLS |
| CustomShowTags.N | 否 | Array of String | 用户自定义展示标签列表 |
| PayMode | 否 | Integer | 修改计费模式 1为预付费 0为按量付费 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功事例
修改APM Instance参数
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApmInstance
<公共请求参数>
{
"InstanceId": "abc",
"Tags": [],
"Description": "abc",
"TraceDuration": 0,
"Name": "abc",
"OpenBilling": true,
"SpanDailyCounters": 1,
"ErrRateThreshold": 5,
"SampleRate": 50,
"ErrorSample": 1,
"SlowRequestSavedThreshold": 500,
"IsRelatedLog": 0,
"LogRegion": "",
"LogTopicID": "",
"LogSet": "",
"LogSource": ""
}输出示例
{
"Response": {
"RequestId": "abc"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | AuthFailure.UnauthorizedOperation |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AccessTagFail | 访问标签失败。 |
| FailedOperation.AppIdNotMatchInstanceInfo | appid和实例信息不匹配。 |
| FailedOperation.InstanceIdIsEmpty | 实例ID为空。 |
| FailedOperation.InstanceNotFound | apm实例不存在。 |
| FailedOperation.SendRequest | 发送查询请求失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |