tencent cloud

Feedback

DescribePeakBaseOverview

Last updated: 2022-06-01 18:41:26

1. API Description

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

This API is used to get the peak data of basic information such as CPU, memory, and disk.

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: DescribePeakBaseOverview.
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.
StartTime No String Start time (xxxx-xx-xx), such as 2019-08-14. It is 7 days ago by default and should not be more than 90 days ago.
EndTime No String End time (xxxx-xx-xx), such as 2019-08-14. It is yesterday by default and should not be more than 90 days ago. When the time period between the start time and end time is within 30 days, data at the 1-hour granularity will be returned; otherwise, data at the 3-hour granularity will be returned.

3. Output Parameters

Parameter Name Type Description
PeakFamilyInfoSet Array of PeakFamilyInfo List of basic peaks.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying basic data on overview page

This example shows you how to query the basic data on the overview page.

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribePeakBaseOverview
&StartTime=2020-09-04
&EndTime=2020-09-04
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "d043adf2-ee74-418a-a1a5-5c63a052b481",
    "PeakFamilyInfoSet": [
      {
        "InstanceFamily": {
          "InstanceFamilyTypeName": "Standard S4",
          "InstanceFamilyType": "S4"
        },
        "PeakBaseSet": [
          {
            "PeakCpuNum": 8018,
            "RecordTime": "2020-09-04 00:00:00",
            "PeakMemoryNum": 16044,
            "PeakStorageNum": 90676
          },
          {
            "PeakCpuNum": 8018,
            "RecordTime": "2020-09-04 01:00:00",
            "PeakMemoryNum": 16044,
            "PeakStorageNum": 90676
          },
          {
            "PeakCpuNum": 8018,
            "RecordTime": "2020-09-04 02:00:00",
            "PeakMemoryNum": 16044,
            "PeakStorageNum": 90676
          },
          {
            "PeakCpuNum": 8018,
            "RecordTime": "2020-09-04 03:00:00",
            "PeakMemoryNum": 16044,
            "PeakStorageNum": 90676
          },
          {
            "PeakCpuNum": 8018,
            "RecordTime": "2020-09-04 04:00:00",
            "PeakMemoryNum": 16044,
            "PeakStorageNum": 90676
          },
          {
            "PeakCpuNum": 8018,
            "RecordTime": "2020-09-04 05:00:00",
            "PeakMemoryNum": 16044,
            "PeakStorageNum": 90676
          },
          {
            "PeakCpuNum": 8018,
            "RecordTime": "2020-09-04 06:00:00",
            "PeakMemoryNum": 16044,
            "PeakStorageNum": 90676
          },
          {
            "PeakCpuNum": 8018,
            "RecordTime": "2020-09-04 07:00:00",
            "PeakMemoryNum": 16044,
            "PeakStorageNum": 90676
          }
        ]
      },
      {
        "InstanceFamily": {
          "InstanceFamilyTypeName": "Standard SN3ne",
          "InstanceFamilyType": "SN3ne"
        },
        "PeakBaseSet": [
          {
            "PeakCpuNum": 433,
            "RecordTime": "2020-09-04 00:00:00",
            "PeakMemoryNum": 882,
            "PeakStorageNum": 5529
          },
          {
            "PeakCpuNum": 433,
            "RecordTime": "2020-09-04 01:00:00",
            "PeakMemoryNum": 882,
            "PeakStorageNum": 5529
          },
          {
            "PeakCpuNum": 433,
            "RecordTime": "2020-09-04 02:00:00",
            "PeakMemoryNum": 882,
            "PeakStorageNum": 5529
          },
          {
            "PeakCpuNum": 433,
            "RecordTime": "2020-09-04 03:00:00",
            "PeakMemoryNum": 882,
            "PeakStorageNum": 5529
          },
          {
            "PeakCpuNum": 433,
            "RecordTime": "2020-09-04 04:00:00",
            "PeakMemoryNum": 882,
            "PeakStorageNum": 5529
          },
          {
            "PeakCpuNum": 433,
            "RecordTime": "2020-09-04 05:00:00",
            "PeakMemoryNum": 882,
            "PeakStorageNum": 5529
          },
          {
            "PeakCpuNum": 433,
            "RecordTime": "2020-09-04 06:00:00",
            "PeakMemoryNum": 882,
            "PeakStorageNum": 5529
          },
          {
            "PeakCpuNum": 433,
            "RecordTime": "2020-09-04 07:00:00",
            "PeakMemoryNum": 882,
            "PeakStorageNum": 5529
          }
        ]
      }
    ]
  }
}

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
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.InvalidTime The time is invalid.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support