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.
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 |
| 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. |
Query the instance ID list under the unified cluster
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"
}{
"Response": {
"TotalCount": 1,
"InstanceIds": [
"cynosdbmysql-ins-pgbpxt11"
],
"RequestId": "51169b54-61d4-4604-a07e-e519a5527923"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 obtain permissions. Try again later. If the issue persists, contact customer service. |
| FailedOperation.CamSigAndAuthError | Authentication failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.DatabaseAccessError | Database access failed. Try again later. If the issue persists, contact customer service. |
| InternalError.DbOperationFailed | Query database failed. |
| InternalError.SystemError | Internal system error. |
| InternalError.UnknownError | Unknown internal error. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
文档反馈