查询回收站实例列表

最近更新时间:2024-09-05 01:25:41

我的收藏

1. 接口描述

接口请求域名: cynosdb.tencentcloudapi.com 。

本接口(DescribeIsolatedInstances)用于查询回收站实例列表。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIsolatedInstances。
Version String 公共参数,本接口取值:2019-01-07。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
Limit Integer 返回数量,默认为 20,最大值为 100
示例值:20
Offset Integer 记录偏移量,默认值为0
示例值:0
OrderBy String 排序字段,取值范围:
  • CREATETIME:创建时间
  • PERIODENDTIME:过期时间

  • 示例值:CREATETIME
    OrderByType String 排序类型,取值范围:
  • ASC:升序排序
  • DESC:降序排序

  • 示例值:ASC
    Filters.N Array of QueryFilter 搜索条件,若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
    DbType String 引擎类型:目前支持“MYSQL”, “POSTGRESQL”
    示例值:MYSQL

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 实例个数
    示例值:1
    InstanceSet Array of CynosdbInstance 实例列表
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询回收站实例列表

    输入示例

    https://cynosdb.tencentcloudapi.com/?Action=DescribeIsolatedInstances
    &Limit=20
    &Offset=0
    &Filters.0.Names.0=InstanceId
    &Filters.0.Values.0=cynosdbpg-ins-bzkxxrmt
    &DbType=MYSQL
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 0,
            "InstanceSet": [
                {
                    "Uin": "abc",
                    "AppId": 0,
                    "ClusterId": "abc",
                    "ClusterName": "abc",
                    "InstanceId": "abc",
                    "InstanceName": "abc",
                    "ProjectId": 0,
                    "Region": "abc",
                    "Zone": "abc",
                    "Status": "abc",
                    "StatusDesc": "abc",
                    "DbMode": "abc",
                    "DbType": "abc",
                    "DbVersion": "abc",
                    "Cpu": 0,
                    "Memory": 0,
                    "Storage": 0,
                    "InstanceType": "abc",
                    "InstanceRole": "abc",
                    "UpdateTime": "2020-09-22 00:00:00",
                    "CreateTime": "2020-09-22 00:00:00",
                    "VpcId": "abc",
                    "SubnetId": "abc",
                    "Vip": "abc",
                    "Vport": 0,
                    "PayMode": 0,
                    "PeriodEndTime": "2020-09-22 00:00:00",
                    "DestroyDeadlineText": "abc",
                    "IsolateTime": "2020-09-22 00:00:00",
                    "NetType": 0,
                    "WanDomain": "abc",
                    "WanIP": "abc",
                    "WanPort": 0,
                    "WanStatus": "abc",
                    "DestroyTime": "abc",
                    "CynosVersion": "abc",
                    "ProcessingTask": "abc",
                    "RenewFlag": 0,
                    "MinCpu": 0,
                    "MaxCpu": 0,
                    "ServerlessStatus": "abc",
                    "StorageId": "abc",
                    "StoragePayMode": 0,
                    "PhysicalZone": "abc",
                    "BusinessType": "abc",
                    "Tasks": [
                        {
                            "TaskId": 0,
                            "TaskType": "abc",
                            "TaskStatus": "abc",
                            "ObjectId": "abc",
                            "ObjectType": "abc"
                        }
                    ],
                    "IsFreeze": "abc",
                    "ResourceTags": [
                        {
                            "TagKey": "abc",
                            "TagValue": "abc"
                        }
                    ],
                    "MasterZone": "abc",
                    "SlaveZones": [
                        "abc"
                    ],
                    "InstanceNetInfo": [
                        {
                            "InstanceGroupType": "abc",
                            "InstanceGroupId": "abc",
                            "VpcId": "abc",
                            "SubnetId": "abc",
                            "NetType": 0,
                            "Vip": "abc",
                            "Vport": 0,
                            "WanDomain": "abc",
                            "WanIP": "abc",
                            "WanPort": 0,
                            "WanStatus": "abc"
                        }
                    ],
                    "ResourcePackages": [
                        {
                            "PackageId": "abc",
                            "PackageType": "abc",
                            "DeductionPriority": 0
                        }
                    ],
                    "InstanceIndexMode": "abc",
                    "InstanceAbility": {
                        "IsSupportForceRestart": "abc",
                        "NonsupportForceRestartReason": "abc"
                    },
                    "DeviceType": "abc"
                }
            ],
            "RequestId": "abc"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.CamCheckResourceError 获取权限失败,请稍后重试。如果持续不成功,请联系客服进行处理。
    FailedOperation.CamSigAndAuthError 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。
    FailedOperation.DatabaseAccessError 数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
    InternalError.DbOperationFailed 查询数据库失败。
    InternalError.SystemError 系统内部错误。
    InvalidParameterValue.IllegalOrderBy 无效的排序字段。
    InvalidParameterValue.InvalidParameterValueError 参数值无效。
    InvalidParameterValue.ParamBothSetError 该两个参数不可以同时设定。
    UnauthorizedOperation.PermissionDenied CAM鉴权不通过。