1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
查询调用指标数据散点图
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeInvocationMetricScatterPlot。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| StartTime | 否 | Timestamp | 查询开始时间,格式yyyy-MM-dd HH:mm:ss 示例值:2020-06-03 17:11:49 | 
| EndTime | 否 | Timestamp | 查询结束时间,格式yyyy-MM-dd HH:mm:ss 示例值:2020-06-03 17:21:49 | 
| Period | 否 | Integer | 查询时间粒度,单位秒。可选值:60、3600、86400 示例值:60 | 
| MetricDimensions.N | 否 | Array of MetricDimension | 查询指标维度, 不能为空。Name, Valeu键值对形式。Name可选值 NamespaceId:命名空间ID,GroupId:部署组ID,InstanceId:实例ID,ApplicationId:应用ID,OperationMethod:执行方法,OperationName:执行名称,ServiceName:服务名,UpstreamNamespaceId:上游命名空间ID | 
| Metrics.N | 否 | Array of Metric | 查询指标名, 不能为空。仅支持 range_count_duration(响应耗时分布) 为 key 下的 sum(求和) 方法 | 
| Kind | 否 | String | 视图视角。可选值:SERVER:服务端, CLIENT:客户端。默认为SERVER 示例值:SERVER | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | InvocationMetricScatterPlot | 多值时间统计指标 注意:此字段可能返回 null,表示取不到有效值。 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 DescribeInvocationMetricDataCurve
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeInvocationMetricScatterPlot
&StartTime=2020-06-03 17:11:49
&EndTime=2020-06-03 17:21:49
&MetricDimensions.0.Name=NamespaceId
&MetricDimensions.0.Value=namespace-6a79x94v
&Metrics.0.Name=request_count
&Metrics.0.Function=sum
&<公共请求参数>输出示例
{
    "Response": {
        "Result": {
            "EndTime": 0,
            "StartTime": 0,
            "Period": 0,
            "DataPoints": [
                {
                    "Points": [
                        {
                            "Values": [
                                0
                            ]
                        }
                    ],
                    "MetricName": "namespaceId",
                    "PointKeys": [
                        "time"
                    ]
                }
            ]
        },
        "RequestId": "96561cf1-738a-47d6-943b-dec7ebbccabe"
    }
}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.TsfApmCtsdbClientRequestError | TSF应用性能管理CTSDB客户端调用失败。 | 
| FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。 | 
| InvalidParameter.ParamError | 参数错误。 | 
| InvalidParameter.TsfApmStatsSearchRequestParamError | TSF应用性能管理运行状态统计查询请求参数错误。 | 
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 |