DescribeInstancesWithinSameCluster

Last updated: 2025-11-13 20:51:27

DescribeInstancesWithinSameCluster

Last updated: 2025-11-13 20:51:27

1. API Description

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

This API is used to query the instance list under the same cluster.

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: DescribeInstancesWithinSameCluster.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
UniqVpcId	Yes	String	vpcId
Vip	Yes	String	vip

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of instances.
InstanceIds	Array of String	Instance ID 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 Query the Instance ID List Within the Unified Cluster

This example shows you how to query the instance ID list within the unified cluster.

Input Example

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

{
    "UniqVpcId": "vpc-gy34u12n",
    "Vip": "172.1.1.1"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "InstanceIds": [
            "cynosdbmysql-ins-pgbpxt11"
        ],
        "RequestId": "51169b54-61d4-4604-a07e-e519a5527923"
    }
}

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

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.CamCheckResourceError	Failed to get permissions. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CamSigAndAuthError	Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError	Failed to access the database. Please try again later. If the problem persists, please contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InternalError.SystemError	Internal system error.
InternalError.UnknownError	Unknown internal error.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud