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


1. API Description

Domain name for API request:

This API (DescribeComponentInfo) is used to obtain the component information.

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: DescribeComponentInfo
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.
ComponentId Yes Integer Component ID.

3. Output Parameters

Parameter Name Type Description
Id Integer Component ID.
ComponentName String Component name.
ComponentType String Component Type.
  • WEB: Web component
  • SYSTEM: System component
  • Homepage String Component website.
    Description String Component description.
    RequestId String The unique ID of a request, which is required for each troubleshooting case.

    4. Example

    Example 1 Obtain component information

    Input example
    &<Common request parameters>

    Output example

      "Response": {
        "Description": "description",
        "ComponentName": "Mysql-Server",
        "ComponentType": "WEB",
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "Homepage": "",
        "Id": 100010

    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.
    MissingParameter A parameter is missing.
    ResourceNotFound Resource does not exist.