1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
修改RemoteWrite任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyRemoteWriteTask。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TaskId | 是 | String | 任务id 示例值:3b2e99eb-9665-4d67-ad52-e24dbd |
| TopicId | 是 | String | 日志主题id 示例值:3b2e99eb-9665-4d67-ad52-e24dbd |
| Enable | 否 | Integer | 任务状态 0 关闭 1 开启 |
| Name | 否 | String | RemoteWrite任务名称 示例值:RemoteWrite任务 |
| NetType | 否 | Integer | 1 内网 2外网 |
| VpcId | 否 | String | 私有网络id 示例值:vpc-xxxx |
| Target | 否 | String | 目标服务名称 示例值:Premotheus |
| RemoteWriteURL | 否 | String | 目标地址 |
| AuthType | 否 | Integer | 0: 无鉴权 1: basic_auth 2: token |
| AuthInfo | 否 | RemoteWriteAuthInfo | 鉴权信息 |
| VirtualGatewayType | 否 | Integer | 后端服务类型 -1 没有 0 CVM 1025 CLB |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改RemoteWrite 任务详情
修改RemoteWrite 任务详情
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRemoteWriteTask
<公共请求参数>
{
"TaskId": "xxx-xxx-xxx-xxx",
"TopicId": "xxx-xxx-xxx-xxx",
"Enable": 0,
"Name": "test",
"NetType": 1,
"VpcId": "cls-xxxx",
"Target": "Prometheus",
"RemoteWriteURL": "http://127.0.0.1:80/api/v1/write",
"AuthType": 1,
"AuthInfo": {
"Username": "test",
"Password": "passwrod",
"Token": ""
}
}
输出示例
{
"Response": {
"RequestId": "xxx-xxx-xxx-xxx"
}
}
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 | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DbDuplication | 数据库唯一键冲突。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |