tencent cloud

Gateway Load Balancer

Release Notes and Announcements
Release Notes
Product Introduction
Overview
Use Cases
Strengths
Technical Principles
Product Feature Comparison
Use Limits
Purchase Guide
Billing Overview
Billable Items
Purchase Methods
Payment Overdue
Quick Start
Operation Guide
GWLB Instance
GWLB Listener
Target Group
Health Check
Monitoring and Alarms
Practical Tutorial
Easily Implementing Adaptation of a Third-Party Virtual Device with GWLB
Implementing HA Across Multiple AZs
Ops Guide
Stress Testing FAQ
API Documentation
History
Introduction
API Category
Making API Requests
Target Group APIs
GWLB APIs
Other APIs
Data Types
Error Codes
FAQs
Billing
GWLB Configuration
Troubleshooting Health Check Issues
Service Level Agreement
GWLB Policy
Privacy Policy
Data Processing and Security Agreement
Contact Us
Glossary
ドキュメントGateway Load BalancerAPI DocumentationTarget Group APIsDescribeTargetGroupInstanceStatus

DescribeTargetGroupInstanceStatus

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-11-13 21:02:14

1. API Description

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

This API is used to query the backend service status of a target group. Currently, only GWLB type target groups support querying backend service status.

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: DescribeTargetGroupInstanceStatus.
Version Yes String Common Params. The value used for this API: 2024-09-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TargetGroupId Yes String Unique target group ID
TargetGroupInstanceIps.N No Array of String List of backend service IPs bound to the target group

3. Output Parameters

Parameter Name Type Description
TargetGroupInstanceSet Array of TargetGroupInstanceStatus Health check backend RS status list
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 Backend Service Status of a GWLB Target Group in batches

This example shows you how to query the backend service status of a GWLB target group in batches.

Input Example

POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTargetGroupInstanceStatus
<common request parameters>

{
    "TargetGroupId": "lbtg-3j3****",
    "TargetGroupInstanceIps": [
        "10.0.1.13",
        "10.0.1.5"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "b3ba6587-1a1c-47eb-ac8b-0424bf3fdc86",
        "TargetGroupInstanceSet": [
            {
                "InstanceIp": "10.0.1.13",
                "Status": "on"
            },
            {
                "InstanceIp": "10.0.1.5",
                "Status": "on"
            }
        ]
    }
}

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

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

前の記事へ: ModifyTargetGroupInstancesWeight次の記事へ: CreateGatewayLoadBalancer

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック