停止容器部署组

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

1. 接口描述

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

停止容器部署组

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

接口更新时间:2026-02-04 22:25:01。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:StopContainerGroup
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId 是 否 String 部署组ID,可通过调用DescribeContainerGroups查询已创建的容器部署组列表或登录控制台进行查看;也可以调用CreateContainGroup创建新的容器部署组。
示例值:  

3. 输出参数

参数名称 类型 描述
Result Bool 停止操作是否成功。
true:停止成功
false:停止失败
示例值:  
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InternalError.ContainergroupKuberneteConnectError 连接TKE服务失败。
InternalError.ContainergroupKuberneteApiInvokeError 访问TKE服务失败。
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
FailedOperation.ContainergroupGroupHasstop 部署组处于停止状态,无法执行此操作。
ResourceNotFound.ContainergroupGroupNotFound 无法找到该部署组。
FailedOperation.ContainergroupKuberneteApiInvokeError 调用 kube-api-server 失败。
InvalidParameterValue.ContainergroupGroupidNull 部署组ID不能为空。

5. 示例

示例1 停止容器部署组

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=StopContainerGroup
&GroupId=group-xxxxxxx
&<Common Parameters>

输出示例

{
  "Response": {
    "RequestId": "0e17c464-cfc7-4209-8314-78b848e28640",
    "Result": true
  }
}