Domain name for API request: cynosdb.tencentcloudapi.com.
This API is used to show the details of an instance.
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: DescribeClusterDetail. |
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. |
ClusterId | Yes | String | Cluster ID |
Parameter Name | Type | Description |
---|---|---|
Detail | CynosdbClusterDetail | Cluster details |
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. |
集群信息描述
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterDetail
<common request parameters>
{
"ClusterId": "cynosdbpg-5804k48e"
}
{
"Response": {
"Detail": {
"ClusterId": "abc",
"ClusterName": "abc",
"Region": "abc",
"Zone": "abc",
"PhysicalZone": "abc",
"Status": "abc",
"StatusDesc": "abc",
"ServerlessStatus": "abc",
"StorageId": "abc",
"Storage": 0,
"MaxStorageSize": 0,
"MinStorageSize": 0,
"StoragePayMode": 0,
"VpcName": "abc",
"VpcId": "abc",
"SubnetName": "abc",
"SubnetId": "abc",
"Charset": "abc",
"CreateTime": "abc",
"DbType": "abc",
"DbMode": "abc",
"DbVersion": "abc",
"StorageLimit": 0,
"UsedStorage": 0,
"Vip": "abc",
"Vport": 0,
"RoAddr": [
{
"IP": "abc",
"Port": 0
}
],
"Ability": {
"IsSupportSlaveZone": "abc",
"NonsupportSlaveZoneReason": "abc",
"IsSupportRo": "abc",
"NonsupportRoReason": "abc"
},
"CynosVersion": "abc",
"BusinessType": "abc",
"HasSlaveZone": "abc",
"IsFreeze": "abc",
"Tasks": [
{
"TaskId": 0,
"TaskType": "abc",
"TaskStatus": "abc",
"ObjectId": "abc",
"ObjectType": "abc"
}
],
"MasterZone": "abc",
"SlaveZones": [
"abc"
],
"InstanceSet": [
{
"InstanceId": "abc",
"InstanceName": "abc",
"InstanceType": "abc",
"InstanceStatus": "abc",
"InstanceStatusDesc": "abc",
"InstanceCpu": 0,
"InstanceMemory": 0,
"InstanceStorage": 0,
"InstanceRole": "abc",
"MaintainStartTime": 0,
"MaintainDuration": 0,
"MaintainWeekDays": [
"abc"
],
"ServerlessStatus": "abc"
}
],
"PayMode": 0,
"PeriodEndTime": "abc",
"ProjectID": 0,
"ResourceTags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"ProxyStatus": "abc",
"LogBin": "abc",
"IsSkipTrade": "abc",
"PitrType": "abc",
"IsOpenPasswordComplexity": "abc",
"NetworkStatus": "abc",
"ResourcePackages": [
{
"PackageId": "abc",
"PackageType": "abc"
}
],
"RenewFlag": 0,
"NetworkType": "abc",
"SlaveZoneAttr": [
{
"Zone": "ap-guangzhou-5",
"BinlogSyncWay": "async"
}
]
},
"RequestId": "abc"
}
}
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.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. |
FailedOperation.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
InternalError.DbOperationFailed | Failed to query the database. |
InternalError.GetVpcFailed | Failed to get the VPC. |
InternalError.InternalHttpServerError | An exception occurred while executing the HTTP request. |
InternalError.SystemError | Internal system error. |
InternalError.UnknownError | Unknown internal error. |
InvalidParameterValue.ClusterNotFound | No cluster found. |
InvalidParameterValue.InstanceNotFound | The instance does not exist. |
InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
InvalidParameterValue.SubnetNotFound | The selected subnet could not be found. |
OperationDenied.VersionNotSupportError | Serverless is not supported on this version. |
ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?