Announcements

[Jun 1, 2022] ECM Supporting Daily Billing for Network Bandwidth

User Guide

Product Introduction

Overview

Strengths

Scenarios

Instance Types

Purchase Guide

Billing Overview

Purchase Methods

Payment Overdue

Notes

Getting Started

Operation Guide

Logging in to Linux Instance

Managing Windows Instance

Managing ECM Module

Managing Instance

Managing Security Group

Managing Image

Editing Tag

EIP Direct Access

API Documentation

History

API Category

Making API Requests

Region APIs

Module APIs

Instance APIs

Image APIs

VPC APIs

Subnet APIs

Route Table APIs

CLB APIs

ENI APIs

EIP APIs

HAVIP APIs

Other API

Key APIs

Security Group APIs

Data Types

Error Codes

FAQs

Glossary

ECM Policy

Data Processing And Security Agreement

DescribeBaseOverview

PDF

Focus Mode

Font Size

Last updated: 2025-10-30 21:41:51

1. API Description

Domain name for API request: ecm.intl.tencentcloudapi.com.

This API is used to get the basic data displayed on the overview page.

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: DescribeBaseOverview.
Version	Yes	String	Common Params. The value used for this API: 2019-07-19.
Region	No	String	Common Params. This parameter is not required for this API.

3. Output Parameters

Parameter Name	Type	Description
ModuleNum	Integer	Number of modules
NodeNum	Integer	Number of nodes
VcpuNum	Integer	Number of CPU cores
MemoryNum	Integer	Memory size in GB
StorageNum	Integer	Disk size in GB
NetworkNum	Integer	Yesterday's network peak in Mbps
InstanceNum	Integer	Number of instances
RunningNum	Integer	Number of running instances
IsolationNum	Integer	Number of isolated instances
ExpiredNum	Integer	Number of expired instances
WillExpireNum	Integer	Number of instances about to expire
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Displaying basic statistics on overview page

This example shows you how to display the basic statistics on the overview page.

Input Example

https://ecm.intl.tencentcloudapi.com/?Action=DescribeBaseOverview
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "62914bef-f8fb-44a5-83a8-df8fe1324f3c",
        "InstanceNum": 5,
        "RunningNum": 4,
        "IsolationNum": 0,
        "ModuleNum": 12,
        "NodeNum": 2,
        "VcpuNum": 12,
        "MemoryNum": 24,
        "StorageNum": 250,
        "NetworkNum": 0,
        "ExpiredNum": 0,
        "WillExpireNum": 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

Tencent Cloud CLI 3.0

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
FailedOperation.InternalOperationFailure	Internal error.
InvalidParameter.InvalidDataFormat	The data format is incorrect.
MissingParameter.MissingOverViewParameter	The request parameters required to get the configuration of the overview page are incomplete.
UnauthorizedOperation.ForbiddenOperation	You don't have the permission to perform this operation.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Edge Computing Machine