DescribeOriginGroupHealthStatus

Last updated: 2024-12-03 16:17:27

1. API Description

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

This API is used to query the health status of origin server groups under a LoadBalancer. The load balancing feature is in beta test. If you need to use it, contact us.

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: DescribeOriginGroupHealthStatus.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Zone ID.
LBInstanceId	Yes	String	CLB instance ID.
OriginGroupIds.N	No	Array of String	Origin server group ID. If left empty, the health status of all origin server groups under a LoadBalancer is obtained by default.

3. Output Parameters

Parameter Name	Type	Description
OriginGroupHealthStatusList	Array of OriginGroupHealthStatusDetail	Health status of origin servers in an origin server group.
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 the Health Status of Origin Servers Under a LoadBalancer

This example shows you how to query the health status of origin servers under a LoadBalancer.

Input Example

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

{
    "ZoneId": "zone-2ju9lrmqaxol",
    "LBInstanceId": "lb-2mzy6je01y82",
    "OriginGroupIds": [
        "og-30l5kv5z2bse"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "2b891f6f-3317-4c31-a1dd-5b2e53eaae4e",
        "OriginGroupHealthStatusList": [
            {
                "CheckRegionHealthStatus": [
                    {
                        "Healthy": "Unhealthy",
                        "OriginHealthStatus": [
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "2.2.2.2"
                            },
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "1.1.1.1"
                            }
                        ],
                        "Region": "BR-SP"
                    },
                    {
                        "Healthy": "Unhealthy",
                        "OriginHealthStatus": [
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "2.2.2.2"
                            },
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "1.1.1.1"
                            }
                        ],
                        "Region": "CN-JX"
                    },
                    {
                        "Healthy": "Unhealthy",
                        "OriginHealthStatus": [
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "2.2.2.2"
                            },
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "1.1.1.1"
                            }
                        ],
                        "Region": "NL-NH"
                    },
                    {
                        "Healthy": "Unhealthy",
                        "OriginHealthStatus": [
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "1.1.1.1"
                            },
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "2.2.2.2"
                            }
                        ],
                        "Region": "CN-SD"
                    },
                    {
                        "Healthy": "Unhealthy",
                        "OriginHealthStatus": [
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "2.2.2.2"
                            },
                            {
                                "Healthy": "Unhealthy",
                                "Origin": "1.1.1.1"
                            }
                        ],
                        "Region": "US-FL"
                    }
                ],
                "OriginGroupId": "og-30l5kv5z2bse",
                "OriginHealthStatus": [
                    {
                        "Healthy": "Unhealthy",
                        "Origin": "2.2.2.2"
                    },
                    {
                        "Healthy": "Unhealthy",
                        "Origin": "1.1.1.1"
                    }
                ]
            }
        ]
    }
}

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

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

tencent cloud

Recent Pages