容器部署组列表

最近更新时间: 2026-09-17 00:04:01

1. 接口描述

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

容器部署组列表

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

接口更新时间：2025-08-22 14:33:19。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeContainerGroups
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
SearchWord	否	否	String	搜索字段，模糊搜索groupName字段示例值：
ApplicationId	否	否	String	分组所属应用ID。必填示例值：
OrderBy	否	否	String	排序字段，默认为 createTime字段，支持id， name， createTime 示例值：
OrderType	否	否	Int64	排序方式，默认为1：倒序排序，0：正序，1：倒序示例值：
Offset	否	否	Int64	偏移量，取值从0开始示例值：
Limit	否	否	Int64	分页个数，默认为20，取值应为1~50 示例值：
ClusterId	否	否	String	集群ID 示例值：
NamespaceId	否	否	String	命名空间 ID 示例值：

3. 输出参数

参数名称	类型	描述
Result	ContainGroupResult	查询的权限数据对象示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter.ParamError	参数错误。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.ContainergroupSqlFailed	容器应用SQL错误。
InvalidParameterValue.ContainergroupApplicationIdNull	所属应用ID不能为空。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense	缺少License。。

5. 示例

示例1 查询容器部署组列表

查询容器部署组列表

输入示例

https://tsf.api3.<no value>/?Action=DescribeContainerGroups
&ApplicationId=application-xxxxxxx
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "41a08459-9e0b-4609-841b-0859d6f844e1",
    "Result": {
      "TotalCount": 1,
      "Content": [
        {
          "Server": "ccr.ccs.<no value>",
          "CpuLimit": "2.00",
          "GroupId": "group-xxxxxxx",
          "ClusterId": "cls-xxxxxxx",
          "TagName": "20190517xxxxxxx",
          "CpuRequest": "",
          "MemLimit": "4096.00",
          "GroupName": "test",
          "Reponame": "tsf_410xxxxxxx/test",
          "CreateTime": "",
          "NamespaceId": "namespace-xxxxxxx",
          "MemRequest": "",
          "ClusterName": "示例",
          "NamespaceName": "test"
        }
      ]
    }
  }
}