1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
查询java实例jvm监控数据,返回数据可选
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeJvmMonitor。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| InstanceId | 是 | String | 查询的实例ID 可通过调用DescribeClusterInstances查询已导入的实例列表或登录控制台进行查询。实例ID例如:ins-6decplwk 示例值:ins-6a79x94v | 
| ApplicationId | 是 | String | 实例所属应用ID 可通过调用DescribeApplications查询已经存在的应用列表或登录控制台查看。应用ID例如:application-v378ewna 示例值:application-6a79x94v | 
| TimeGranularity | 是 | Integer | 时间粒度,单位:秒 示例值:60 | 
| From | 是 | String | 查询数据起始时间格式(yyyy-MM-dd HH:mm:ss) 示例值:2022-12-30 12:32:56 | 
| To | 是 | String | 查询数据结束时间格式(yyyy-MM-dd HH:mm:ss) 示例值:2022-12-30 14:32:56 | 
| RequiredPictures.N | 是 | Array of String | 查询的监控图列表,以返回值属性名作为入参,可选值: heapMemory:堆内存监控图;nonHeapMemory:非堆内存监控图;edenSpace:伊甸区监控图;survivorSpace:幸存者区监控图;oldSpace:老年代监控图;metaSpace:元空间监控图;youngGC:youngGC增量监控图;fullGC:fullGC增量监控图;cpuUsage:cpu使用率监控图;classCount:加载类数监控图;threadPicture:线程图 示例值:["heapMemory"] | 
| Tag | 否 | String | 扩展字段 示例值:time | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | JvmMonitorData | Java实例jvm监控数据 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 查询java实例jvm监控数据
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeJvmMonitor
&ApplicationId=application-evjmv9vb
&InstanceId=ins-1vogaxgk
&TimeGranularity=60
&From=2020-03-20 10:20:00
&To=2020-03-20 11:20:00
&RequiredPictures.0=heapMemory
&RequiredPictures.1=nonHeapMemory
&RequiredPictures.2=edenSpace
&RequiredPictures.3=survivorSpace
&<公共请求参数>输出示例
{
    "Response": {
        "RequestId": "79d5d365-9be9-48f1-841a-9e5c59dec1a1",
        "Result": {
            "ClassCount": null,
            "CpuUsage": null,
            "EdenSpace": {
                "Committed": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "124780544"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "129499136"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "129499136"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "129499136"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "44040192"
                    }
                ],
                "Max": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "176160768"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "177733632"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "177733632"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "177733632"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "177733632"
                    }
                ],
                "Used": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "12437984"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "88456608"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "60516048"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "26705136"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "32410424"
                    }
                ]
            },
            "FullGC": null,
            "HeapMemory": {
                "Committed": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "214958080"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "219676672"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "219676672"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "219676672"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "134217728"
                    }
                ],
                "Max": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "477626368"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "477626368"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "477626368"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "477626368"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "477626368"
                    }
                ],
                "Used": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "68157296"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "140723544"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "112782984"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "78972080"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "84712408"
                    }
                ]
            },
            "MetaSpace": null,
            "NonHeapMemory": {
                "Committed": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "123797504"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "119078912"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "119078912"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "119078912"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "119078912"
                    }
                ],
                "Max": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "1317011456"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "1317011456"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "1317011456"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "1317011456"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "1317011456"
                    }
                ],
                "Used": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "118819272"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "114262008"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "114262008"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "114262008"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "114262008"
                    }
                ]
            },
            "OldSpace": null,
            "SurvivorSpace": {
                "Committed": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "524288"
                    }
                ],
                "Max": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "524288"
                    }
                ],
                "Used": [
                    {
                        "Label": "2024-12-24 16:04:54",
                        "Timestamp": "1735027494069",
                        "Value": "524288"
                    },
                    {
                        "Label": "2024-12-24 16:03:54",
                        "Timestamp": "1735027434066",
                        "Value": "196608"
                    },
                    {
                        "Label": "2024-12-24 16:02:54",
                        "Timestamp": "1735027374063",
                        "Value": "196608"
                    },
                    {
                        "Label": "2024-12-24 16:01:54",
                        "Timestamp": "1735027314059",
                        "Value": "196608"
                    },
                    {
                        "Label": "2024-12-24 16:00:54",
                        "Timestamp": "1735027254056",
                        "Value": "311312"
                    }
                ]
            },
            "ThreadPicture": null,
            "YoungGC": null
        }
    }
}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.TsfCmonitorCtsdbClientRequestFail | ctsdb数据库请求失败。 | 
| FailedOperation.TsfMonitorWaitedTimeout | TSF监控统计等待超时, 请稍后重试。 | 
| FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。 | 
| InternalError.TsfMonitorDateParseFailed | TSF监控统计时间日期解析失败。 | 
| InternalError.TsfMonitorInternalError | TSF监控统计内部异常, 请稍后重试。 | 
| InvalidParameter.BadRequest | 示例:serviceId模块接口action请求不正确(400 BAD REQUEST)。 | 
| InvalidParameter.TsfMonitorRequestParamIllegal | TSF监控统计请求参数非法。 | 
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 | 
| UnauthorizedOperation.NoLicense | 缺少License,请参考购买指南购买TSF资源后重试。 | 
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。 |