DescribeComponentStatistics

Last updated: 2019-06-26 20:07:55

1. API Description

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

This API (DescribeComponentStatistics) is used to obtain the component statistics list.

Default request rate limit: 20/sec.

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 parameter. The value​used for this API: DescribeComponentStatistics
Version Yes String Common parameter. The value used for this API: 2/28/2018
Region No String Common parameter. This parameter is not required for this API.
Limit No Integer Number of returned results. It defaults to 10. The maximum is 100.
Offset No Integer Offset. It defaults to 0.
Filters.N No Array of Filter Filter condition.
ComponentName - String - Required: No - Component name

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of records in the component statistics list.
ComponentStatistics Array of ComponentStatistics Array of the component statistics list.
RequestId String The unique ID of a request, which is required for each troubleshooting case.

4. Example

Example 1 Obtain the component statistics list

Input example

https://yunjing.tencentcloudapi.com/?Action=DescribeComponentStatistics
&Limit=10
&Offset=0
&<Common request parameters>

Output example

{
  "Response": {
    "TotalCount": 100,
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "ComponentStatistics": [
      {
        "ComponentType": "WEB",
        "ComponentName": "machine-name",
        "MachineNum": 10,
        "Id": 100010,
        "Description": "description"
      }
    ]
  }
}

5. Resources for Developers

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using cloud APIs.

SDK

Cloud API 3.0 comes with the software development kit (SDK) that supports multiple programming languages and makes it easier to call the APIs.

Command line tools

6. Error Codes

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

Error Code Description
InternalError Internal error.
InvalidParameter.IllegalRequest Invalid request.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameter.ParsingError Parameter parsing error.
MissingParameter A parameter is missing.