tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeParamTemplates

Last updated: 2024-11-20 11:12:33

    1. API Description

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

    This API is used to query the parameter template list. The common request parameter Region can only be set to ap-guangzhou.

    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 Params. The value used for this API: DescribeParamTemplates.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-singapore.
    EngineVersions.N No Array of String Engine version. If it is left empty, all parameter templates will be queried.
    EngineTypes.N No Array of String Engine type. If it is left empty, all engine types will be queried.
    TemplateNames.N No Array of String Template name. If it is left empty, all template names will be queried.
    TemplateIds.N No Array of Integer Template ID. If it is left empty, all template IDs will be queried.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of parameter templates of the user.
    Items Array of ParamTemplateInfo Parameter template details.
    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 Querying parameter template list

    Input Example

    https://cdb.intl.tencentcloudapi.com/?Action=DescribeParamTemplates
&<common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "756bb037-a44a-4b4f-abe0-6efd34a6c792",
        "TotalCount": 1,
        "Items": [
            {
                "TemplateId": 2333,
                "Name": "test",
                "Description": "test",
                "EngineVersion": "5.7"
            }
        ]
    }
}

    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
    AuthFailure CAM signature/authentication error.
    CdbError.DatabaseError Backend database error.
    InternalError.ParamError Parameter error
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameterValue.DataConvertError Data conversion failed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy