tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyLoadBalancing

Last updated: 2022-11-28 16:50:36
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to modify a CLB instance.

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: ModifyLoadBalancing.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId Yes String The site ID.
LoadBalancingId Yes String The load balancer ID.
Type Yes String The proxy mode. Values:
  • dns_only: Only DNS
  • proxied: Proxied
    		•
    OriginGroupId Yes String The ID of the primary origin group.
    BackupOriginGroupId Yes String The ID of the secondary origin group (only available when Type=proxied). If not specified, it indicates that secondary origins are not used.
    TTL No Integer When Type=dns_only, it indicates the amount of time that DNS records remain in the cache of a DNS server.
    Value range: 60-86400 (in seconds). If it's not specified, the default value 600 will be used.
    OriginType No String The origin-pull type. Values:
  • normal: Primary/Secondary origin-pull
  • advanced: Advanced origin-pull (only used when Type=proxied)
    • If it is left empty, primary/secondary origin-pull is applied.
    AdvancedOriginGroups.N No Array of AdvancedOriginGroup Advanced origin-pull configuration. This field is valid when OriginType=advanced.
    If it is left empty, this configuration is not used.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying a CLB instance

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLoadBalancing
<Common request parameters>

{
    "ZoneId": "zone-27q0p0bali16",
    "LoadBalancingId": "lb-97c8396e-cb88-4c9c-98d9-38e86463d12e",
    "Type": "dns_only",
    "OriginGroupId": "orgin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a",
    "BackupOriginGroupId": "",
    "TTL": 600
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
    }
}

    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
    OperationDenied Operation denied.
    ResourceNotFound The resource doesn’t exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy