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

1. API Description

Domain name for API request:

This API (DescribeComponents) is used to obtain the component 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: DescribeComponents
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.
Uuid No String Unique Uuid of the HS client. Either Uuid or ComponentId should be specified. If Uuid is specified, it means querying the host list.
ComponentId No Integer Component ID. Either Uuid or ComponentId should be specified. If ComponentId is specified, it means querying the list of the specified component.
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.
  • ComponentVersion - String - Required: No - Component version
  • MachineIp - String - Required: No - Host private IP
  • 3. Output Parameters

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

    4. Example

    Example 1 Obtain the component list

    Input example
    &<Common request parameters>

    Output example

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

    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.

    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.