1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
服务统计页面:接口和服务维度
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeStatistics。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| Type | 是 | String | 统计类型。可选值 Interface:接口类型、Service:服务类型、Group:部署组类型、Instance:实例类型、SQL:SQL类型、NoSQL:NoSQL类型 示例值:Interface | 
| TimeStep | 是 | Integer | 步长,单位秒。可选值 60、3600、86400 示例值:60 | 
| Offset | 是 | Integer | 偏移量,取值范围大于等于0,默认值为0 示例值:0 | 
| Limit | 是 | Integer | 单页请求配置数量,取值范围[1, 50],默认值为10 示例值:50 | 
| NamespaceId | 否 | String | 命名空间ID。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一。 可通过DescribeSimpleNamespaces查询已经创建的命名空间,也可以通过登录控制台查看 示例值:namespace-6a79x94v | 
| OrderBy | 否 | String | 排序字段:AvgTimeConsuming[默认]、RequestCount、ErrorRate。实例监控还支持 CpuPercent 示例值:AvgTimeConsuming | 
| OrderType | 否 | Integer | 排序方式:ASC:0、DESC:1 示例值:1 | 
| EndTime | 否 | Timestamp | 开始时间:年月日 时分秒2020-05-12 14:43:12, 不能为空 示例值:2020-05-12 14:43:12 | 
| StartTime | 否 | Timestamp | 开始时间:年月日 时分秒2020-05-12 14:43:12, 不能为空 示例值:2020-05-12 14:42:12 | 
| ServiceName | 否 | String | 服务名称 示例值:demo-service | 
| SearchWord | 否 | String | 搜索关键词 示例值:demo | 
| MetricDimensionValues.N | 否 | Array of MetricDimensionValue | 维度。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一 | 
| BucketKey | 否 | String | 聚合关键词 示例值:application | 
| DbName | 否 | String | 数据库名称 示例值:tsf_demo | 
| NamespaceIdList.N | 否 | Array of String | 命名空间ID数组。此字段,和 NamespaceIdList 或者 MetricDimensionValues 字段包含 namespaceId 维度信息。三者选其一 示例值:["namespace-6a79x94v"] | 
| ConfigCenterInstanceId | 否 | String | 独占配置中心的ID。 可通过调用DescribeClusterInstances查询已导入的实例列表或登录控制台进行查询。实例ID例如:ins-6decplwk。 示例值:ins-6a79x94v | 
| ServiceFilter | 否 | String | 服务过滤 示例值:normal | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | ServiceStatisticsResults | 查询服务统计结果 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 test
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStatistics
<公共请求参数>
{
    "OrderBy": "AvgTimeConsuming",
    "StartTime": "2020-05-12 14:43:12",
    "TimeStep": 60,
    "Offset": 0,
    "DbName": "mysql",
    "ServiceName": "demo-service",
    "Limit": 10,
    "SearchWord": "keyword",
    "OrderType": 1,
    "EndTime": "2020-05-12 14:43:12",
    "Type": "Service",
    "NamespaceId": "namespace-xxxxxxxx",
    "ServiceFilter": "normal"
}输出示例
{
    "Response": {
        "RequestId": "b057eeaa-ccdf-40be-995f-f059b4b974e8",
        "Result": {
            "TotalCount": 2,
            "Content": []
        }
    }
}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.CallTsfDcfgFailed | TSF应用性能管理调用tsf-dcfg模块失败 | 
| FailedOperation.FindMetricsExclusiveError | 寻找独占配置中心相关指标异常 | 
| FailedOperation.TsfApmCallTsfMsFailed | TSF应用性能管理调用tsf-ms模块失败。 | 
| FailedOperation.TsfApmCtsdbClientRequestError | TSF应用性能管理CTSDB客户端调用失败。 | 
| FailedOperation.TsfApmEsClientRequestError | TSF应用性能管理ES客户端调用失败。 | 
| FailedOperation.TsfApmInternalError | TSF应用性能管理内部异常, 请稍后重试。 | 
| FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。 | 
| FailedOperation.UnhandledException | 模块未处理异常。 | 
| InternalError.TsfApmCallTsfMsFailed | TSF应用性能管理调用tsf-ms模块失败。 | 
| InternalError.TsfApmInternalError | TSF应用性能管理内部异常, 请稍后重试。 | 
| InvalidParameter.TsfApmTraceSearchRequestParamError | TSF应用性能管理调用链搜索请求参数错误。 | 
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 | 
| UnauthorizedOperation.NoLicense | 缺少License,请参考购买指南购买TSF资源后重试。 | 
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。 | 
| UnsupportedOperation.UnsupportAction | 不支持的ACTION。 |