tencent cloud

文档反馈

DescribeComponentStatistics

最后更新时间:2024-12-06 15:41:52

    1. API Description

    This API will be disused soon.

    Planned disuse time: 2025-02-01 16:32:52

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

    接口已无效

    This API is used to obtain the data of the component statistics list.

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

    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: DescribeComponentStatistics.
    Version Yes String Common Params. The value used for this API: 2018-02-28.
    Region No String Common Params. This parameter is not required.
    Limit No Integer Quantity of returns. It is 10 by default, and the maximum value is 100.
    Offset No Integer Offset, which defaults to 0
    Filters.N No Array of Filter Filter criteria
    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 list of counted components
    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 Obtaining a Component Statistics List

    This example shows you how to obtain a component statistics list.

    Input Example

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

    Output Example

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

    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
    InvalidParameter Incorrect parameter.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持