1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
查询主机概览信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMachineGeneral。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MachineCnt | Integer | 资产总数 示例值:132 |
ProtectMachineCnt | Integer | 已防护机器数 示例值:34 |
BaseMachineCnt | Integer | 已防护基础版机器数 示例值:34 |
SpecialtyMachineCnt | Integer | 已防护专业版机器数 示例值:0 |
FlagshipMachineCnt | Integer | 已防护旗舰版机器数 示例值:34 |
RiskMachineCnt | Integer | 存在风险的机器数 示例值:35 |
CompareYesterdayRiskMachineCnt | Integer | 比较昨日风险机器数 示例值:35 |
CompareYesterdayNotProtectMachineCnt | Integer | 比较昨日未防护机器数 示例值:64 |
CompareYesterdayDeadlineMachineCnt | Integer | 比较昨日即将到期的机器数 示例值:2 |
DeadlineMachineCnt | Integer | 即将到期的机器数 示例值:2 |
NotProtectMachineCnt | Integer | 未防护机器数 示例值:64 |
LHGeneralDiscountCnt | Integer | 已防护轻量机器数(Lighthouse机器) 示例值:0 |
CompareYesterdayMachineCnt | Integer | 比较昨日新增的主机数 示例值:132 |
MachineDestroyAfterOfflineHours | Integer | 自动清理时间,最大720小时,最小0, 默认0 ,0=关闭 示例值:1 |
CloudFrom | Array of CloudFromCnt | 云服务器类型数组 示例值:[ { "CloudFrom": 0, "MachineCnt": 124 }, { "CloudFrom": 1, "MachineCnt": 2 }, { "CloudFrom": 2, "MachineCnt": 6 } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
查询主机资产概览
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMachineGeneral
<公共请求参数>
{}
输出示例
{
"Response": {
"AliCloudMachineCnt": 0,
"BaiduCloudMachineCnt": 0,
"BaseMachineCnt": 34,
"CloudFrom": [
{
"CloudFrom": 0,
"MachineCnt": 124
},
{
"CloudFrom": 1,
"MachineCnt": 2
},
{
"CloudFrom": 2,
"MachineCnt": 6
}
],
"CompareYesterdayDeadlineMachineCnt": 2,
"CompareYesterdayMachineCnt": 132,
"CompareYesterdayNotProtectMachineCnt": 64,
"CompareYesterdayRiskMachineCnt": 35,
"DeadlineMachineCnt": 2,
"FlagshipMachineCnt": 34,
"IDCMachineCnt": 0,
"LHGeneralDiscountCnt": 0,
"MachineCnt": 132,
"MachineDestroyAfterOfflineHours": 1,
"NotProtectMachineCnt": 64,
"OtherCloudMachineCnt": 0,
"ProtectMachineCnt": 34,
"RequestId": "9f5fd122-589a-4faa-b004-efd7ef35e240",
"RiskMachineCnt": 35,
"SpecialtyMachineCnt": 0,
"TencentCloudMachineCnt": 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 | 内部错误。 |