服务统计
最近更新时间: 2026-10-11 00:12:02
1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.com。
服务统计页面:接口和服务维度
默认接口请求频率限制:10000次/秒。
接口更新时间:2026-03-06 17:33:11。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeStatistics |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| OrderType | 否 | 否 | Uint64 | 排序方式:ASC:0、DESC:1 示例值: |
| SearchWord | 否 | 否 | String | 搜索关键词 示例值: |
| DbName | 否 | 否 | String | 数据库 示例值: |
| BucketKey | 否 | 否 | String | 聚合关键词 示例值: |
| Type | 是 | 否 | String | 类型:Interface、Service、Group、Instance、SQL、NoSQL 示例值: |
| TimeStep | 是 | 否 | Uint64 | 步长,单位s:60、3600、86400 示例值: |
| ConfigCenterInstanceId | 否 | 是 | String | 独占配置中心的ID 示例值: |
| Limit | 是 | 否 | Uint64 | 单页请求配置数量,取值范围[1, 50],默认值为10 示例值: |
| EndTime | 否 | 否 | Datetime | 开始时间:年月日 时分秒2020-05-12 14:43:12, 不能为空 示例值: |
| StartTime | 否 | 否 | Datetime | 开始时间:年月日 时分秒2020-05-12 14:43:12, 不能为空 示例值: |
| ServiceName | 否 | 否 | String | 服务名称 示例值: |
| MetricDimensionValues | 否 | 否 | Array of MetricDimensionValue | 维度 示例值:查看 |
| NamespaceIdList | 否 | 否 | Array of String | 命名空间id数组 示例值: |
| Offset | 是 | 否 | Uint64 | 偏移量,取值范围大于等于0,默认值为0 示例值: |
| NamespaceId | 否 | 否 | String | 命名空间Id,此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。 示例值: |
| OrderBy | 否 | 否 | String | 排序字段:AvgTimeConsuming[默认]、RequestCount、ErrorRate。实例监控还支持 CpuPercent 示例值: |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | ServiceStatisticsResults | 查询服务统计结果 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.TsfApmInternalError | TSF应用性能管理内部异常, 请稍后重试。 |
| UnsupportedOperation.UnsupportAction | 不支持的ACTION。。 |
| FailedOperation.TsfApmEsClientRequestError | TSF应用性能管理ES客户端调用失败。 |
| FailedOperation.TsfApmCtsdbClientRequestError | TSF应用性能管理CTSDB客户端调用失败。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。。 |
| InvalidParameter.TsfApmTraceSearchRequestParamError | TSF应用性能管理调用链搜索请求参数错误。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| UnauthorizedOperation.NoLicense | 缺少License。。 |
| InternalError.TsfApmCallTsfMsFailed | TSF应用性能管理调用tsf-ms模块失败。 |
| FailedOperation.UnhandledException | 模块未处理异常。 |
| FailedOperation.TsfApmCallTsfMsFailed | TSF应用性能管理调用tsf-ms模块失败。 |
| FailedOperation.TsfApmInternalError | TSF应用性能管理内部异常, 请稍后重试。 |
| FailedOperation.CallTsfDcfgFailed | |
| FailedOperation.FindMetricsExclusiveError |
5. 示例
示例1 test
输入示例
POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeStatistics
<Common Parameters>
{
"OrderBy":"desc",
"StartTime":"2020-05-12 14:43:12",
"TimeStep":"1",
"Offset":"1",
"DbName":"db-1",
"ServiceName":"sevice-a",
"Limit":"1",
"NamespaceIdList":[
"namespace-dadas"
],
"SearchWord":"even",
"OrderType":"1",
"EndTime":"2020-05-12 14:43:12",
"Type":"interface",
"NamespaceId":"namespace-dsadsa",
"BucketKey":"alam",
"MetricDimensionValues":[
{
"Name":"fullgc_count",
"Value":[
"1"
]
}
]
}
输出示例
{
"Response": {
"RequestId": "b057eeaa-ccdf-40be-995f-f059b4b974e8",
"Result": {
"TotalCount": 2,
"Content": []
}
}
}