DescribeCustomizedConfigList

Last updated: 2021-09-15 10:37:01

1. API Description

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

This API is used to pull custom configuration lists to return the user configuration of AppId.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com

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: DescribeCustomizedConfigList.
Version Yes String Common parameter. The value used for this API: 2018-03-17.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ConfigType Yes String Configuration type. Valid values: CLB (CLB-specific configs), SERVER (domain name-specific configs), and LOCATION (forwarding rule-specific configs).
Offset No Integer Pagination offset. Default: 0.
Limit No Integer Number of results per page. Default: 20.
ConfigName No String Specifies the name of configs to query. Fuzzy match is supported.
UconfigIds.N No Array of String Configuration ID.
Filters.N No Array of Filter The filters are:
  • loadbalancer-id - String - Required: no - (filter) CLB instance ID, such as "lb-12345678".
  • vip - String - Required: no - (filter) CLB instance VIP, such as "1.1.1.1" and "2204::22:3".
  • 3. Output Parameters

    Parameter Name Type Description
    ConfigList Array of ConfigListItem Configuration list.
    TotalCount Integer Number of configurations.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying configuration details

    Input Example

    https://clb.tencentcloudapi.com/?Action=DescribeCustomizedConfigList
    &ConfigType=CLB
    &Offset=0
    &Limit=3
    &<Common request parameters>
    

    Output Example

    {
      "Response": {
        "ConfigList": [
          {
            "UconfigId": "pz-go2gs3d6",
            "ConfigType": "CLB",
            "ConfigContent": "client_max_body_size 1m;",
            "ConfigName": "122222",
            "CreateTimestamp": "2019-11-28 20:44:24",
            "UpdateTimestamp": "2020-03-01 11:11:27"
          }
        ],
        "TotalCount": 1,
        "RequestId": "d6f74bc7-2b26-4f5f-9dd8-6f0c8e8e2cc2"
      }
    }
    

    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameter.LBIdNotFound Wrong CLB instance ID.
    InvalidParameter.ListenerIdNotFound Wrong listener ID.
    InvalidParameter.LocationNotFound Unable to find eligible forwarding rules.
    InvalidParameter.PortCheckFailed Listener port checks failed due to port conflicts or other reasons.
    InvalidParameter.ProtocolCheckFailed Listener protocol checks failed because the protocol used is incompatible with the corresponding operation.
    InvalidParameter.RegionNotFound Invalid region.
    InvalidParameter.RewriteAlreadyExist The forwarding rule has already been bound to a redirection relationship.
    InvalidParameter.SomeRewriteNotFound Some redirection rules do not exist.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Duplicate Duplicate parameter value.
    InvalidParameterValue.Length Wrong parameter length.
    LimitExceeded Quota exceeded.
    MissingParameter Missing parameter.
    ResourceInsufficient Insufficient resources.
    UnauthorizedOperation Unauthorized operation.