DescribeComponents

Last updated: 2020-07-31 11:19:00

1. API Description

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

This API is used to get the component list.

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 parameter. The value used for this API: DescribeComponents.
Version Yes String Common parameter. The value used for this API: 2018-02-28.
Region No String Common parameter. This parameter is not required for this API.
Uuid No String CWP agent Uuid. Either Uuid or ComponentId must be specified. If Uuid is specified, it indicates to query the information list under the specified server.
ComponentId No Integer Component ID. Either Uuid or ComponentId must be specified. If ComponentId is specified, it indicates to query the information list under the specified component.
Limit No Integer Number of results to be returned. Default value: 10. Maximum value: 100.
Offset No Integer Offset. Default value: 0.
Filters.N No Array of Filter Filter.
  • ComponentVersion - String - Required: No - Component version number
  • MachineIp - String - Required: No - Private IP of server
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of records in component list.
    Components Array of Component Component list data.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting component list

    This example shows you how to get the component list.

    Input Example

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

    Output Example

    {
      "Response": {
        "Components": [
          {
            "Id": 1,
            "MachineIp": "10.12.13.22",
            "MachineName": "machine-name",
            "ModifyTime": "2018-01-01 12:12:12",
            "ComponentVersion": "5.7.16",
            "ComponentType": "WEB",
            "ComponentName": "Mysql Server",
            "Uuid": "6b6cd843-6bc1-4011-a74c-dc3fd26a7dd1"
          }
        ],
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "TotalCount": 100
      }
    }

    5. Developer Resources

    API Explorer

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

    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.IllegalRequest Invalid request.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameter.ParsingError Parameter parsing error.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help