1. API Description
Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This interface is used for querying the recycle bin instance list.
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.
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: DescribeIsolatedInstances. |
| 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. |
| Limit |
No |
Integer |
Number of returned results. the default value is 20. the maximum value is 100. |
| Offset |
No |
Integer |
Record offset. default value: 0. |
| OrderBy |
No |
String |
Sorting field. valid values:. CREATETIME: creation time. PERIODENDTIME: expiration time. |
| OrderByType |
No |
String |
Sorting type. value range:. ASC: specifies ascending sort.. DESC: sorts in descending order. . |
| Filters.N |
No |
Array of QueryFilter |
Search criteria. when multiple filters exist, the relationship between filters is logical AND. |
| DbType |
No |
String |
Engine type: currently supports "MYSQL", "POSTGRESQL". |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
Number of instances. |
| InstanceSet |
Array of CynosdbInstance |
Instance 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 Inquiry Recycle Bin Instance List
https:
&Limit=20
&Offset=0
&Filters.0.Names.0=InstanceId
&Filters.0.Values.0=cynosdbpg-ins-bzkxxrmt
&DbType=MYSQL
&<Common request parameters>
Output Example
{
"Response": {
"InstanceSet": [
{
"AppId": 1311111346,
"BusinessType": "",
"ClusterId": "cynosdbmysql-grhvkwd",
"ClusterName": "cynosdbmysql-grhvkwd",
"Cpu": 2,
"CreateTime": "2024-12-03 14:03:58",
"CynosVersion": "2.1.13.001",
"DbMode": "NORMAL",
"DbType": "MYSQL",
"DbVersion": "5.7",
DestroyDeadlineText: "<7 days"
"DestroyTime": "2024-12-30 19:51:33",
"DeviceType": "exclusive",
"InstanceAbility": {
"IsSupportForceRestart": "no",
"NonsupportForceRestartReason": "NoForcedRestartAllowed"
},
"InstanceId": "cynosdbmysql-ins-crl6j3l",
"InstanceIndexMode": "onlyRowIndex",
"InstanceName": "cynosdbmysql-ins-crl6j3l",
"InstanceNetInfo": [
{
"InstanceGroupId": "cynosdbmysql-grp-r7hmdx4",
"InstanceGroupType": "ha",
"NetType": 1,
"SubnetId": "subnet-oiz56c8",
"Vip": "172.0.0.2",
"VpcId": "vpc-gy34uq2",
"Vport": 3306,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"InstanceRole": "master",
"InstanceStorageType": "",
"InstanceType": "rw",
"IsFreeze": "no",
"IsolateTime": "2024-12-23 19:51:33",
"MasterZone": "ap-chongqing-1",
"MaxCpu": 0,
"Memory": 4,
"MinCpu": 0,
"NetType": 1,
"PayMode": 1,
"PeriodEndTime": "2024-12-23 19:51:24",
"PhysicalZone": "ap-chongqing-1",
"ProcessingTask": "",
"ProjectId": 0,
"Region": "ap-chongqing",
"RenewFlag": 1,
"ResourcePackages": null,
"ResourceTags": null,
"ServerlessStatus": "",
"SlaveZones": [],
"Status": "isolated",
"StatusDesc": "Isolated"
"Storage": 10,
"StorageId": "cynosdbmysql-grhvkwd",
"StoragePayMode": 1,
"SubnetId": "subnet-oiz56c8",
"Tasks": [],
"Uin": "100011147054",
"UpdateTime": "2024-12-23 19:51:33",
"Vip": "172.0.0.2",
"VpcId": "vpc-gy34uq2",
"Vport": 3306,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init",
"Zone": "ap-chongqing-1"
},
{
"AppId": 1311111346,
"BusinessType": "",
"ClusterId": "cynosdbmysql-grhvkwd",
"ClusterName": "cynosdbmysql-grhvkwd",
"Cpu": 2,
"CreateTime": "2024-12-03 14:03:58",
"CynosVersion": "2.1.13.001",
"DbMode": "NORMAL",
"DbType": "MYSQL",
"DbVersion": "5.7",
DestroyDeadlineText: "<7 days"
"DestroyTime": "2024-12-30 19:51:33",
"DeviceType": "exclusive",
"InstanceAbility": {
"IsSupportForceRestart": "no",
"NonsupportForceRestartReason": "NoForcedRestartAllowed"
},
"InstanceId": "cynosdbmysql-ins-6t9ynb7",
"InstanceIndexMode": "onlyRowIndex",
"InstanceName": "cynosdbmysql-ins-6t9ynb7",
"InstanceNetInfo": [
{
"InstanceGroupId": "cynosdbmysql-grp-08o6vj0",
"InstanceGroupType": "singleRo",
"NetType": 1,
"SubnetId": "subnet-oiz56c8",
"Vip": "172.0.0.7",
"VpcId": "vpc-gy34uq2",
"Vport": 3306,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"InstanceRole": "ro",
"InstanceStorageType": "",
"InstanceType": "ro",
"IsFreeze": "no",
"IsolateTime": "2024-12-23 19:51:33",
"MasterZone": "ap-chongqing-1",
"MaxCpu": 0,
"Memory": 4,
"MinCpu": 0,
"NetType": 1,
"PayMode": 1,
"PeriodEndTime": "2024-12-23 19:51:24",
"PhysicalZone": "ap-chongqing-1",
"ProcessingTask": "",
"ProjectId": 0,
"Region": "ap-chongqing",
"RenewFlag": 1,
"ResourcePackages": null,
"ResourceTags": null,
"ServerlessStatus": "",
"SlaveZones": [],
"Status": "isolated",
"StatusDesc": "Isolated"
"Storage": 10,
"StorageId": "cynosdbmysql-grhvkwd",
"StoragePayMode": 1,
"SubnetId": "subnet-oiz56c8",
"Tasks": [],
"Uin": "100011147054",
"UpdateTime": "2024-12-23 19:51:33",
"Vip": "172.0.0.7",
"VpcId": "vpc-gy34uq2",
"Vport": 3306,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init",
"Zone": "ap-chongqing-1"
}
],
"RequestId": "8f291dbc-3840-40f9-aa39-841437c247fb",
"TotalCount": 2
}
}
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
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. |
| InvalidParameterValue.IllegalOrderBy |
Invalid sort by field. |
| InvalidParameterValue.InvalidParameterValueError |
Invalid parameter value. |
| InvalidParameterValue.ParamBothSetError |
These two parameters cannot be set at the same time. |
| UnauthorizedOperation.PermissionDenied |
CAM authentication failed. |