1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
Prometheus 内部动态 api 代理,仅内部使用
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ExportPrometheusReadOnlyDynamicAPI。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 点查询(Instant query)
Path: api/v1/query
Method: GET POST
Query参数:
1. query = <string> prometheus查询表达式
2. time = <rfc3339 | unix_timestamp> 查询数据的时间
3. timeout = <duration> 超时时间 (1m / 5s / ...)
响应体:
{
"status": "success" | "error",
"data": {
"resultType": "matrix" | "vector" | "scalar" | "string",
"result": <value>
},
// 错误时返回
"errorType": "<string>",
"error": "<string>",
// warning 信息
"warnings": ["<string>"]
}
查询结果result字段参考prometheus点查询结果编码
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportPrometheusReadOnlyDynamicAPI
<公共请求参数>
{}
输出示例
{
"Response": {
"RequestId": "8-ztbsc3gc2-rw6lzn4gfg5kuz6khrxg"
}
}
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.AccessCAMFail | 访问鉴权失败。 |
AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
FailedOperation | 操作失败。 |
FailedOperation.DataColumnNotFound | 数据表字段不存在。 |
FailedOperation.DataQueryFailed | 数据查询失败。 |
FailedOperation.DataTableNotFound | 数据表不存在。 |
FailedOperation.DbQueryFailed | 数据库查询失败。 |
FailedOperation.DbRecordCreateFailed | 创建数据库记录失败。 |
FailedOperation.DbRecordDeleteFailed | 数据库记录删除失败。 |
FailedOperation.DbRecordUpdateFailed | 数据库记录更新失败。 |
FailedOperation.DbTransactionBeginFailed | 数据库事务开始失败。 |
FailedOperation.DbTransactionCommitFailed | 数据库事务提交失败。 |
FailedOperation.InstanceNotFound | 实例不存在。 |
FailedOperation.InternalError | 内部服务错误。 |
FailedOperation.ResourceNotFound | 资源不存在。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidAppId | 无效的AppId。 |
InvalidParameter.InvalidParameter | 参数错误。 |
InvalidParameter.InvalidParameterParam | 参数错误。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |