查询实例

最近更新时间：2024-03-12 01:53:15

我的收藏

本页目录：

1. 接口描述

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

查询实例

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClusterInstances。
Version	是	String	公共参数，本接口取值：2021-11-18。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：tdcpg-xxx
PageNumber	否	Integer	页码，取值范围为[1,INF)，默认值为1 示例值：1
PageSize	否	Integer	每页个数，取值范围为默认为[1,100]，默认值为20 示例值：10
Filters.N	否	Array of Filter	目前支持查询条件包括： - InstanceId : 实例ID - InstanceName : 实例名 - EndpointId : 接入点ID - Status : 实例状态 - InstanceType : 实例类型
OrderBy	否	String	排序字段，可选字段： - CreateTime : 实例创建时间(默认值) - PayPeriodEndTime : 实例过期时间示例值：CLUSTER_CREATE_TIME
OrderByType	否	String	排序方式，可选字段： - DESC : 降序(默认值) - ASC : 升序示例值：DESC

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总条数示例值：100
InstanceSet	Array of Instance	实例列表信息示例值：[]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例

输入示例

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

{
    "ClusterId": "tdcpg-77iesdqa",
    "OrderBy": "CreateTime",
    "OrderByType": "DESC",
    "PageNumber": 1,
    "Filters": [
        {
            "Values": [
                "tdcpg-ins-6c6xs52r"
            ],
            "Name": "InstanceId",
            "ExactMatch": true
        }
    ],
    "PageSize": 10
}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "CPU": 1,
                "ClusterId": "tdcpg-77iesdqa",
                "CreateTime": "2021-12-08T19:50:56+08:00",
                "DBVersion": "10.17",
                "EndpointId": "tdcpg-ep-6c6xs52r",
                "InstanceId": "tdcpg-ins-pzu77n6e",
                "InstanceName": "tdcpg-ins-pzu77n6e",
                "InstanceType": "RW",
                "Memory": 1,
                "PayMode": "PREPAID",
                "PayPeriodEndTime": "2022-01-08T19:50:54+08:00",
                "Region": "ap-guangzhou",
                "Status": "running",
                "StatusDesc": "运行中",
                "Zone": "ap-guangzhou-2"
            }
        ],
        "RequestId": "e0ef1b06-405f-48cc-863f-185dbb6eb037",
        "TotalCount": 1
    }
}

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. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.DatabaseAccessError	元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.InvalidParameterValueError	传入的参数非法。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.PermissionDenied	未经授权的操作。