tencent cloud

APIs

DescribeCustomizedConfigList

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-06-17 17:21:35

1. API Description

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

Pull the list of custom configurations. The configurations of the specified type under the user's AppId will be returned.

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: DescribeCustomizedConfigList.
Version Yes String Common Params. The value used for this API: 2023-04-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ConfigType No String Configuration type. CLB: CLB dimension; SERVER: Domain name dimension; LOCATION: Rule dimension.
Offset No Integer Pagination offset. Default: 0
Limit No Integer Number of results. Default: 20
ConfigName No String Specify the name of configurations to query. Fuzzy match is supported.
ConfigIds.N No Array of String Configuration ID
Filters.N No Array of Filter Filter criteria are as follows:
  • loadbalancer-id - String - Required: No - (Filter condition) Filter by CLB ID, for example: "lb-12345678".
  • vip - String - Required: No - (Filter condition) Filter by CLB vip, for example: "1.1.1.1", "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, 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 Obtaining the Configuration List

    Obtaining the Configuration List

    Input Example

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

    Output Example

    {
        "Response": {
            "ConfigList": [
                {
                    "ConfigId": "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 Incorrect parameter format.
    InvalidParameter.LBIdNotFound CLB instance ID error.
    InvalidParameter.ListenerIdNotFound Listener ID error.
    InvalidParameter.LocationNotFound Unable to find eligible forwarding rules.
    InvalidParameter.PortCheckFailed Listener port check due to port conflicts or other reasons.
    InvalidParameter.ProtocolCheckFailed Listener protocol check failed because, for example, the protocol used is incompatible with the corresponding operation.
    InvalidParameter.RegionNotFound Invalid region.
    InvalidParameter.RewriteAlreadyExist The forwarding rule has been bound to a redirection relationship.
    InvalidParameter.SomeRewriteNotFound Some redirection rules do not exist.
    InvalidParameterValue Parameter value error.
    InvalidParameterValue.Duplicate Duplicate parameter values.
    InvalidParameterValue.InvalidFilter Filter parameter input error.
    InvalidParameterValue.Length Invalid parameter length.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Parameters are missing.
    ResourceInsufficient Insufficient resources.
    UnauthorizedOperation Unauthorized operation.

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백