1. 接口描述
接口请求域名: cloudhsm.tencentcloudapi.com 。
获取VSM监控信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetVsmMonitorInfo。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ResourceId | 是 | String | 资源Id 示例值:hsm-1234abcd |
ResourceName | 否 | String | 资源名称 示例值:default-hsmName |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MonitorInfo | Array of String | VSM监控信息 示例值:json字符串:{"vsm":{"uuid":"C2B7885C-642A-4459-8D8D-D43FD5CFCE35","version":"1.0.19.0_STD","status":"ok","ip":"9.82.42.102","ip6":"","token":"",}} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取VSM监控信息
获取VSM监控信息
输入示例
POST / HTTP/1.1
Host: cloudhsm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetVsmMonitorInfo
<公共请求参数>
{
"ResourceId": "hsm-1234abcd",
"ResourceName": "default-hsmName"
}
输出示例
{
"Response": {
"RequestId": "1709108637",
"MonitorInfo": [
"{\"vsm\":{\"uuid\":\"244584CE-B0FD-4838-A908-484DBB2F760B\",\"version\":\"EST000H1.30.09.rv00\",\"status\":\"ok\",\"ip\":\"9.82.42.104\",\"ip6\":\"\",\"token\":\"\",\"eps\":[{\"algorithm\":\"3DES\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"AES\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"SM1\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"SM4\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"SM2-GEN\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"SM2-ENC\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"SM2-DEC\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"SM2-SIGN\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"SM2-VRFY\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"RSA-GEN\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"RSA-PUB\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"RSA-PRI\",\"eps\":{\"max\":0,\"avg\":0}},{\"algorithm\":\"HASH\",\"eps\":{\"max\":0,\"avg\":0}}],\"cpu\":[{\"cpuid\":\"cpu0\",\"us\":1,\"sy\":0,\"ni\":0,\"id\":99,\"wa\":0,\"hi\":0,\"si\":0,\"st\":0}],\"mem\":{\"total\":1969283072,\"used\":386039808,\"free\":1583243264,\"shared\":3919872,\"buffers\":140079104,\"cached\":119455744},\"swap\":{\"total\":0,\"used\":0,\"free\":0},\"storage\":[{\"file_system\":\"/dev/vda1\",\"total\":8124856,\"used\":834376,\"available\":6871104,\"inodes\":524288,\"iused\":19151,\"ifree\":505137}],\"io\":[{\"device\":\"vda\",\"rrqm_s\":0,\"wrqm_s\":0.34,\"r_s\":0,\"w_s\":0.38,\"rsec_s\":0.01,\"wsec_s\":5.74,\"avgrq_sz\":15.31,\"avgqu_sz\":0,\"await\":12.13,\"svctm\":3.74,\"util\":12.14}],\"network\":[{\"iface\":\"eth0\",\"rxpck_s\":0,\"txpck_s\":0,\"rxbyt_s\":0,\"txbyt_s\":0,\"rxcmp_s\":0,\"txcmp_s\":0,\"rxmcst_s\":0},{\"iface\":\"eth1\",\"rxpck_s\":85.15,\"txpck_s\":0,\"rxbyt_s\":5050,\"txbyt_s\":0,\"rxcmp_s\":0,\"txcmp_s\":0,\"rxmcst_s\":0}],\"load\":{\"load1\":0,\"load5\":0,\"load15\":0},\"process\":{\"total\":110,\"running\":1,\"sleeping\":109,\"stopped\":0,\"zombie\":0},\"tcp\":{\"total\":37,\"established\":33,\"time_wait\":0}}}"
]
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |