查询简单部署组列表

最近更新时间: 2026-10-11 00:12:05

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.com。

查询简单部署组列表

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

接口更新时间：2026-02-04 23:14:57。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeSimpleGroups
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterId	否	否	String	集群ID，不填写时查询全量示例值： cls-6a79x94v
NamespaceId	否	否	String	命名空间ID，不填写时查询全量示例值： namespace-6a79x94v
Limit	否	否	Int64	每页条数示例值： 20
GroupId	否	否	String	部署组ID，不填写时查询全量示例值： group-6a79x94v
AppMicroServiceType	否	否	String	部署组类型，精确过滤字段，M：service mesh, P：原生应用， G：网关应用示例值： N
Offset	否	否	Int64	起始偏移量示例值： 0
SearchWord	否	否	String	模糊查询，部署组名称，不填写时查询全量示例值： abc
GroupIdList	否	否	Array of String	部署组ID列表，不填写时查询全量示例值： ["group-6a79x94v"]
ApplicationId	否	否	String	应用ID，不填写时查询全量示例值： application-6a79x94v
OrderBy	否	否	String	排序字段示例值：

3. 输出参数

参数名称	类型	描述
Result	TsfPageSimpleGroup	简单部署组列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
FailedOperation.GroupQueryFailed	事务分组查询失败。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.GroupQueryFaild	部署组查询失败。
FailedOperation.DispatchCommonError	TSF暂时不能响应请求。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
InvalidParameter.ParamError	参数错误。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
UnauthorizedOperation.NoLicense	缺少License。。
InvalidParameter.BadRequest	[%s]模块接口[%s]请求不正确（400 BAD REQUEST）。。

5. 示例

示例1 查询简单部署组列表

输入示例

https://tsf.cloudapi.com/?Action=DescribeSimpleGroups
&Offset=0
&Limit=20
&ApplicationId=application-6a79x94v
&<Common Parameters>

输出示例

{
  "Response": {
    "RequestId": "f92318c2-55c5-479f-b73e-f63683bee456",
    "Result": {
      "TotalCount": 1,
      "Content": [
        {
          "GroupId": "group-6a79x94v",
          "GroupName": "group-mock",
          "ClusterId": "cls-6a79x94v",
          "ClusterName": "cls-mock",
          "ClusterType": "C",
          "NamespaceId": "namespace-6a79x94v",
          "NamespaceName": "default",
          "ApplicationId": "application-6a79x94v",
          "ApplicationName": "java-service",
          "ApplicationType": "C",
          "AppMicroServiceType": "N",
          "GroupResourceType": "DEF",
          "StartupParameters": "-Dspring.application.name=java-service"
        }
      ]
    }
  }
}