停止组件服务

最近更新时间: 2026-09-17 00:05:48

1. 接口描述

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

停止组件服务

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

接口更新时间：2025-07-17 03:10:29。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：StopService
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	实例ID 示例值： tbds-2fifau5y
ServiceGroup	是	否	Int64	服务组类型通过DescribeServiceGroups接口 ServiceType字段获取示例值： 73
ServiceType	是	否	Int64	服务类型通过DescribeServiceGroups接口 ServiceNodeList.NodeType字段获取示例值： 69
NodeList	否	否	Array of String	需要操作的节点IP列表示例值： 1
ServiceGroupName	否	否	String	需要停止的serviceGroup，all代表全部示例值： 1
ServiceTypeName	否	否	String	需要停止的serviceType，all代表全部示例值： 1
HostUuidList	是	否	Array of String	需要操作的节点uuid列表示例值： [687, 4269]
StopPolicy	否	否	String	safe表示安全暂停，fast表示快速暂停示例值： 1

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InternalError.WoodServerError	内部服务调用异常。
ResourceNotFound.InstanceNotFound	无法找到该实例。
InvalidParameter.InvalidAppId	无效参数，AppId。
ResourceNotFound.ClusterNotFound	无法找到该实例。
ResourceInUse.InstanceInProcess	实例在流程中。
InternalError	内部错误。
InternalError.CamCgwError	内部服务调用异常。

5. 示例

示例1 停止组件服务

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: StopService
<公共请求参数>

{
  "InstanceId": "tbds-2fifau5y",
  "ServiceGroup": 73,
  "ServiceType": 69,
  "Nodelist": [
    "10.4.2.52",
    "10.4.2.13"
  ],
  "HostUuidList": [
    687,
    4269
  ]
}

输出示例

{
    "Response": {
        "RequestId": "c8cad716-eaab-459b-92e2-a2090c7dfce9"
    }
}