1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
容器部署组列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeContainerGroups。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ApplicationId | 是 | String | 分组所属应用ID。 示例值:application-xxx |
SearchWord | 否 | String | 搜索字段,模糊搜索groupName字段 示例值:foo-group |
OrderBy | 否 | String | 排序字段,默认为 createTime字段,支持id, name, createTime 示例值:id |
OrderType | 否 | Integer | 排序方式,默认为1:倒序排序,0:正序,1:倒序 示例值:0 |
Offset | 否 | Integer | 偏移量,取值从0开始 示例值:0 |
Limit | 否 | Integer | 分页个数,默认为20, 取值应为1~50 示例值:20 |
ClusterId | 否 | String | 集群ID 示例值:cls-xxx |
NamespaceId | 否 | String | 命名空间 ID 示例值:namespace-xxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | ContainGroupResult | 查询的权限数据对象 示例值:null |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询容器部署组列表
查询容器部署组列表
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeContainerGroups
&ApplicationId=application-xxxxxxx
&Offset=0
&Limit=10
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "41a08459-9e0b-4609-841b-0859d6f844e1",
"Result": {
"TotalCount": 1,
"Content": [
{
"Server": "ccr.ccs.tencentyun.com",
"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",
"Alias": "test",
"KubeInjectEnable": true,
"UpdatedTime": ""
}
]
}
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。。 |
InternalError.ContainergroupSqlFailed | 容器应用SQL错误。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameterValue.ContainergroupApplicationIdNull | 所属应用ID不能为空。 |
InvalidParameterValue.ContainergroupLimitValueInvalid | limit最大数量,默认 20, 最大值 50。 |
ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
UnauthorizedOperation.NoLicense | 缺少License。。 |
UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |