1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
查询维度
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeInvocationMetricDataDimension。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| StartTime | 是 | String | 开始时间,格式yyyy-MM-dd HH:mm:ss 示例值:2024-11-11 12:21:50 | 
| EndTime | 是 | String | 结束时间,格式yyyy-MM-dd HH:mm:ss 示例值:2024-11-11 12:26:50 | 
| Offset | 是 | Integer | 开始index,取值范围大于等于0,默认值为0 示例值:0 | 
| Limit | 是 | Integer | 单页请求配置数量,取值范围[1, 50],默认值为10 示例值:50 | 
| DimensionName | 是 | String | 聚合维度。可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID 示例值:applicationName | 
| SearchWord | 否 | String | 搜索关键字 示例值:word | 
| MetricDimensionValues.N | 否 | Array of MetricDimensionValue | 构建维度 | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | TsfPageDimension | 维度 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 demo
demo
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInvocationMetricDataDimension
<公共请求参数>
{
    "StartTime": "2024-11-11 12:21:32",
    "DimensionName": "applicationName",
    "Limit": 0,
    "SearchWord": "name",
    "Offset": 0,
    "EndTime": "2024-11-11 12:26:32",
    "MetricDimensionValues": [
        {
            "Name": "key",
            "Value": [
                "value1"
            ]
        }
    ]
}输出示例
{
    "Response": {
        "Result": {
            "Content": [],
            "TotalCount": 0
        },
        "RequestId": "niw82o0-k298s7-akqo20-kx8305"
    }
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| InvalidParameter.TsfApmStatsSearchRequestParamError | TSF应用性能管理运行状态统计查询请求参数错误。 |