查询实例的列表

1. 接口描述

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

本接口(DescribeInstances)用于查询实例列表。

默认接口请求频率限制：1000次/秒。

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询实例列表

查询实例列表

输入示例

POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>

{
    "Limit": 20,
    "Offset": 0,
    "OrderBy": "CREATETIME",
    "OrderByType": "ASC",
    "Filters": [
        {
            "Names": [
                "status"
            ],
            "Values": [
                "running"
            ],
            "ExactMatch": true,
            "Name": "",
            "Operator": ""
        }
    ],
    "DbType": "MYSQL",
    "Status": "running",
    "InstanceIds": [
        "cynosdbmysql-ins-1asd5qwe"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "InstanceSet": [
            {
                "Uin": "238762734",
                "AppId": 23762834,
                "ClusterId": "cynosdbmysql-asd45qwe",
                "ClusterName": "MyClusterName",
                "InstanceId": "cynosdbmysql-ins-asd45qwe",
                "InstanceName": "MyInstanceName",
                "ProjectId": 2342,
                "Region": "ap-guangzhou",
                "Zone": "ap-guangzhou-3",
                "Status": "running",
                "StatusDesc": "运行中",
                "DbMode": "NORMAL",
                "DbType": "MYSQL",
                "DbVersion": "5.7",
                "Cpu": 1,
                "Memory": 1,
                "Storage": 10,
                "InstanceType": "rw",
                "InstanceRole": "master",
                "UpdateTime": "2020-09-22 00:00:00",
                "CreateTime": "2020-09-22 00:00:00",
                "VpcId": "vpc-12as56",
                "SubnetId": "subnet-12kasd",
                "Vip": "192.0.2.1",
                "Vport": 3306,
                "PayMode": 0,
                "PeriodEndTime": "2020-09-22 00:00:00",
                "DestroyDeadlineText": "<5 天",
                "IsolateTime": "2020-09-22 00:00:00",
                "NetType": 1,
                "WanDomain": "cynosdbpg-bzkxxrmt.wan.domain.com",
                "WanIP": "3.1.5.2",
                "WanPort": 3306,
                "WanStatus": "running",
                "DestroyTime": "2024-01-04 00:09:10",
                "CynosVersion": "2.0.10",
                "ProcessingTask": "taskUpgradeStorage",
                "RenewFlag": 0,
                "MinCpu": 1,
                "MaxCpu": 8,
                "ServerlessStatus": "paused",
                "StorageId": "cynosdbpg-bzkxxrmt",
                "StoragePayMode": 0,
                "PhysicalZone": "ap-guangzhou-3",
                "BusinessType": "bus_a",
                "Tasks": [
                    {
                        "TaskId": 111110,
                        "TaskType": "taskCreateClusters",
                        "TaskStatus": "running",
                        "ObjectId": "cynosdbmysql-asd45qwe",
                        "ObjectType": "cluster"
                    }
                ],
                "IsFreeze": "no",
                "ResourceTags": [
                    {
                        "TagKey": "tag_key_1",
                        "TagValue": "tag_value_1"
                    }
                ],
                "MasterZone": "ap-guangzhou-3",
                "SlaveZones": [
                    "ap-guangzhou-4"
                ],
                "InstanceNetInfo": [
                    {
                        "InstanceGroupType": "ha",
                        "InstanceGroupId": "cynosdbmysql-grp-asd45qwe",
                        "VpcId": "vpc-12as45",
                        "SubnetId": "subnet-cbhs7ush",
                        "NetType": 1,
                        "Vip": "192.0.0.0",
                        "Vport": 3306,
                        "WanDomain": "cynosdbpg-bzkxxrmt.wan,domain,com",
                        "WanIP": "23.15.5.1",
                        "WanPort": 3306,
                        "WanStatus": "running"
                    }
                ],
                "ResourcePackages": [
                    {
                        "DeductionPriority": 0,
                        "PackageId": "package-bhsy2snc",
                        "PackageType": "CCU"
                    }
                ],
                "InstanceIndexMode": "onlyRowIndex"
            }
        ],
        "RequestId": "fd5759b5-89e9-483c-b79c-d99b27c33192"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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