API 中心
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>API 中心>微服务平台 TSF>集群相关接口>查询集群实例

查询集群实例

最近更新时间：2024-03-12 01:59:50

我的收藏

本页目录：

1. 接口描述

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

查询集群实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeClusterInstances。
Version 是 String 公共参数，本接口取值：2018-03-26。
Region 是 String 公共参数，详见产品支持的 地域列表。
ClusterId 是 String 集群ID
示例值：cluster-xxxxxxx
SearchWord 否 String 搜索字段
示例值：test
OrderBy 否 String 排序字段
示例值：null
OrderType 否 Integer 排序类型
示例值：0
Offset 否 Integer 偏移量
示例值：0
Limit 否 Integer 分页个数
示例值：20

3. 输出参数

参数名称 类型 描述
Result TsfPageInstance 集群机器实例分页信息
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群机器列表

输入示例

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

{
    "Limit": "20",
    "ClusterId": "cluster-xxxxxxx",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "a92e58d4-b415-4069-910e-c84e60233019",
        "Result": {
            "TotalCount": 2,
            "Content": [
                {
                    "InstanceId": "ins-xxxxxxx",
                    "InstanceName": "consumer",
                    "LanIp": "172.16.0.7",
                    "WanIp": "193.112.32.241",
                    "NamespaceId": "cluster-xxxxxxx",
                    "UpdateTime": null,
                    "InstanceDesc": null,
                    "ClusterId": null,
                    "ClusterName": null,
                    "InstanceStatus": null,
                    "InstanceAvailableStatus": "Abnormal",
                    "ServiceInstanceStatus": "Stopped",
                    "ServiceSidecarStatus": "UnSupported",
                    "OperationState": 6,
                    "CountInTsf": null,
                    "GroupId": "",
                    "GroupName": null,
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "InstanceCreatedTime": null,
                    "InstanceExpiredTime": null,
                    "InstanceChargeType": null,
                    "InstanceTotalCpu": null,
                    "InstanceTotalMem": null,
                    "InstanceUsedCpu": null,
                    "InstanceUsedMem": null,
                    "InstanceLimitCpu": null,
                    "InstanceLimitMem": null,
                    "InstancePkgVersion": "",
                    "ClusterType": null,
                    "InstanceZoneId": null,
                    "RestrictState": null,
                    "InstanceImportMode": "R",
                    "ApplicationType": null
                },
                {
                    "InstanceId": "ins-xxxxxxx",
                    "InstanceName": "provider",
                    "LanIp": "172.16.0.3",
                    "WanIp": "106.52.118.194",
                    "NamespaceId": "cluster-xxxxxxx",
                    "UpdateTime": null,
                    "InstanceDesc": null,
                    "ClusterId": null,
                    "ClusterName": null,
                    "InstanceStatus": null,
                    "InstanceAvailableStatus": "Abnormal",
                    "ServiceInstanceStatus": "Stopped",
                    "ServiceSidecarStatus": "UnSupported",
                    "OperationState": 6,
                    "CountInTsf": null,
                    "GroupId": "",
                    "GroupName": null,
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "InstanceCreatedTime": null,
                    "InstanceExpiredTime": null,
                    "InstanceChargeType": null,
                    "InstanceTotalCpu": null,
                    "InstanceTotalMem": null,
                    "InstanceUsedCpu": null,
                    "InstanceUsedMem": null,
                    "InstanceLimitCpu": null,
                    "InstanceLimitMem": null,
                    "InstancePkgVersion": "",
                    "ClusterType": null,
                    "InstanceZoneId": null,
                    "RestrictState": null,
                    "InstanceImportMode": "R",
                    "ApplicationType": null
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CloudApiProxyError TSF云API请求调用失败。
FailedOperation.ContainergroupKuberneteConnectError 连接 kube-api-sever 失败。
FailedOperation.ContainergroupKubernetesConnectError 调用 kube-api-server 失败。
FailedOperation.GroupQueryFaild 部署组查询失败。
FailedOperation.InstanceQueryFailed 查询机器实例部分失败。
FailedOperation.InstanceUpdateFailed 机器实例更新失败。
FailedOperation.TsfPrivilegeError TSF权限模块异常，请联系系统管理员。。
FailedOperation.UnhandledException 模块未处理异常。
InternalError.CamRoleRequestError TSF云API调用申请角色临时凭证调用请求失败。
InternalError.CloudApiProxyError TSF云API请求调用失败。
InternalError.ClusterNotExistOrPrivilegeError 无法找到部署组，或相应集群/命名空间/应用的权限不足。
InternalError.ContainergroupKuberneteConnectError 连接TKE服务失败。
InternalError.InstanceCommonError TSF节点管理通用错误信息。
InternalError.UnhandledException [%s]模块未处理异常。。
InvalidParameter.ParamError 参数错误。
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
UnauthorizedOperation.CamGeneralError 访问 CAM 系统出错，%s。
UnauthorizedOperation.NoLicense 缺少License。。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
中国站
文档反馈
文档活动
message-icon联系我们
目录