tencent cloud

Feedback

DescribeMachineGeneral

Last updated: 2024-08-27 11:43:58

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to query the information of the host overview.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeMachineGeneral.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
MachineCnt Integer Total number of assets
TencentCloudMachineCnt Integer Number of Tencent Cloud machines
AliCloudMachineCnt Integer Number of Alibaba Cloud machines
BaiduCloudMachineCnt Integer Number of Baidu Cloud machines
IDCMachineCnt Integer Number of IDC machines
OtherCloudMachineCnt Integer Number of machines from other cloud service vendors
ProtectMachineCnt Integer Number of protected machines
BaseMachineCnt Integer Number of protected Basic Edition machines
SpecialtyMachineCnt Integer Number of protected Pro Edition machines
FlagshipMachineCnt Integer Number of protected Ultimate Edition machines
RiskMachineCnt Integer Number of risky machines
CompareYesterdayRiskMachineCnt Integer Number of new risky machines compared with that yesterday
CompareYesterdayNotProtectMachineCnt Integer Number of new unprotected machines compared with that yesterday
CompareYesterdayDeadlineMachineCnt Integer Number of new machines about to expire compared with that yesterday
DeadlineMachineCnt Integer Number of machines about to expire
NotProtectMachineCnt Integer Number of unprotected machines
LHGeneralDiscountCnt Integer Number of protected Inclusive Edition machines (Lighthouse machines)
CompareYesterdayMachineCnt Integer Number of new hosts compared with that yesterday
MachineDestroyAfterOfflineHours Integer Auto-cleanup Time, maximum 720 hours, minimum 0, 0 by default, 0=OFF
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example

Input Example

POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMachineGeneral
<Common request parameters>

{}

Output Example

{
    "Response": {
        "CompareYesterdayNotProtectMachineCnt": 0,
        "IDCMachineCnt": 0,
        "CompareYesterdayDeadlineMachineCnt": 0,
        "OtherCloudMachineCnt": 0,
        "TencentCloudMachineCnt": 0,
        "MachineCnt": 0,
        "BaiduCloudMachineCnt": 0,
        "ProtectMachineCnt": 0,
        "AliCloudMachineCnt": 0,
        "BaseMachineCnt": 0,
        "RequestId": "aa05bbb0-f9c7-4650-b4fe-05685d89b11b",
        "FlagshipMachineCnt": 0,
        "RiskMachineCnt": 0,
        "CompareYesterdayRiskMachineCnt": 0,
        "SpecialtyMachineCnt": 0,
        "DeadlineMachineCnt": 0,
        "NotProtectMachineCnt": 0,
        "CompareYesterdayMachineCnt": 1,
        "LHGeneralDiscountCnt": 0,
        "MachineDestroyAfterOfflineHours": 0
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error