API文档

# 更新历史

# 第53次发布

发布时间：2021-06-16 08:08:41

本次发布包含了以下内容：

改善已有的文档。

新增接口：

新增数据结构：

# 第52次发布

发布时间：2021-05-21 08:08:26

本次发布包含了以下内容：

改善已有的文档。

新增接口：

新增数据结构：

# 第XX次发布

XXX

# API概览

# 微服务网关相关接口

接口名称 接口功能
BindApiGroup (opens new window) 网关与API分组批量绑定

# 服务相关接口

接口名称 接口功能
CreateMicroservice (opens new window) 新增微服务

# XXX相关接口

接口名称 接口功能

# 集群相关接口

# 移除云主机

# 1. 接口描述

接口请求地址： tsf.tencentcloudapi.com 。

查询简单集群列表

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

注意：本接口支持金融区地域。由于金融区和非金融区是隔离不互通的，因此当公共参数 Region 为金融区地域（例如 ap-shanghai-fsi）时，需要同时指定带金融区地域的域名，最好和 Region 的地域保持一致，例如：tsf.ap-shanghai-fsi.tencentcloudapi.com。

# 2. 输入参数

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSimpleClusters。
ClusterType 否 String 需要查询的集群类型，不填或不传入时查询所有内容

# 3. 输出参数

参数名称 类型 描述
Result TsfPageCluster (opens new window) TSF集群分页对象
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

# 4. 示例

# 查询简单集群列表

# 示例1 查询集群机器列表

# 输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeClusterInstances
&ClusterId=cluster-xxxxxxx
&Offset=0
&Limit=20
&<公共请求参数>
1
2
3
4
5
# 输出示例
{
  "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
        }
      ]
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# XXX相关接口

# 数据结构

# AddInstanceResult

添加实例到集群的结果

被如下接口引用：AddClusterInstances。

名称 类型 描述
FailedInstanceIds Array of String 添加集群失败的节点列表
注意：此字段可能返回 null，表示取不到有效值。

# AdvanceSettings

高级选项设置

被如下接口引用：CreateTask, DescribeTaskDetail, DescribeTaskRecords, ModifyTask。

名称 类型 描述
SubTaskConcurrency Integer 子任务单机并发数限制，默认值为2

# XXX

xxxxxx

名称 类型 描述

# 错误码

# 公共错误码

错误码 说明
ActionOffline 接口已下线。

# 业务错误码

错误码 说明
FailedOperation.ApiMetaParseFailed API元数据解析失败。
编辑页面 (opens new window)

← 插件说明→