tencent cloud

Feedback

DescribeLoadBalancingDetail

Last updated: 2022-09-01 15:05:31

1. API Description

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

This API is used to query the details of 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: DescribeLoadBalancingDetail.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId Yes String Site ID
LoadBalancingId Yes String CLB instance ID

3. Output Parameters

Parameter Name Type Description
LoadBalancingId String CLB instance ID
ZoneId String Site ID
Host String Subdomain name. You can use @ to represent the root domain.
Type String Proxy mode. Valid values:
dns_only: Only DNS
proxied: Enable proxy
TTL Integer Indicates DNS TTL time when Type=dns_only
OriginId Array of String ID of the origin group used
Origin Array of OriginGroup Information of the origin server used
UpdateTime Timestamp ISO8601 Update time
Status String Status of the task
Cname String Schedules domain names
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the details of a CLB instance

Input Example

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

{
    "ZoneId": "zone-xxx",
    "LoadBalancingId": "lb-xxx"
}

Output Example

{
    "Response": {
        "RequestId": "xx",
        "Host": "host",
        "LoadBalancingId": "lb-d21bfaf7-8d72-11ec-841d-00ff977fb3c8",
        "Origin": [],
        "OriginId": [],
        "TTL": 123,
        "Type": "type",
        "UpdateTime": "2022-02-14T08:48:03Z",
        "ZoneId": "zid",
        "Status": "online",
        "Cname": "1.2.3.4.com"
    }
}

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
ResourceNotFound The resource doesn’t exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support