简介

最近更新时间:2026-07-07 03:03:09

我的收藏

欢迎使用微服务平台 TSF(Tencent Service Framework,以下简称 TSF)。

腾讯云微服务平台 TSF 是一个围绕着应用和微服务的 PaaS 平台,提供应用管理、注册配置、服务治理和立体化监控功能。TSF 基于 Kubernetes 和 Mesh 微服务底座,提供一站式微服务全生命周期管理能力,帮助企业快速构建、部署和管理微服务应用。

TSF 向用户提供应用托管、服务注册发现、配置管理、服务治理、监控告警等全栈微服务能力。用户可以使用本文档介绍的 API,并参照相应的示例,对 TSF 进行相关操作:如创建应用、部署服务、配置服务路由、查询监控数据等;支持的全部操作可参见 API 概览

请确保在使用这些接口前,已充分了解了 TSF 产品概述

注意:

  • 本章节微服务平台 TSF API 接口均为最新 API 3.0 接口,后续 TSF 相关新增功能都会在此章节更新。我们强烈推荐您使用最新 API 3.0 接口。
  • 现有旧版 API 接口功能依然保持,未来可能停止维护,如您仍需使用旧版接口可参考相关文档。

术语表

本文档涉及的一些常用术语如下:

术语 英文 说明
应用 Application 指一个完整的微服务应用,包含应用代码、运行环境和配置信息。
应用版本 Application Version 应用的特定版本,支持多版本并存和灰度发布。
部署组 Deployment Group 应用部署的最小单元,包含一组相同配置的实例。
命名空间 Namespace 用于隔离和管理微服务资源的逻辑单元,分为统一命名空间和自定义命名空间。
集群 Cluster TSF 管理的计算资源池,支持物理机、虚拟机和容器等多种资源类型。
服务 Service 微服务架构中的一个独立服务单元,提供特定的业务能力。
服务路由 Service Routing 根据规则将请求转发到不同服务实例的能力。
服务鉴权 Service Authentication 对服务调用进行权限控制的能力。
配置管理 Configuration Management 集中管理微服务的配置信息,支持动态配置下发。
服务治理 Service Governance 包括服务路由、服务鉴权、服务限流、服务熔断等能力。

输入参数与返回参数释义

Limit 和 Offset

用来控制分页的参数。Limit 为单次返回的最多条目数量,Offset 为偏移量。当相应结果是列表形式时,如果数量超过了 Limit 所限定的值,那么只返回 Limit 个值。

举例来说,参数 Offset=0&Limit=20 返回第 0 到 19 项,Offset=20&Limit=20 返回第 20 到 39 项,Offset=40&Limit=20 返回第 40 到 59 项;以此类推。

Ids.N

同时输入多个参数的格式。当遇到形如这样的格式时,那么该输入参数可以同时传多个。例如:

GET 请求或者 POST x-www-form-urlencoded 请求:Ids.0=app-xxxx&Ids.1=app-yyyy&Ids.2=app-zzzz

以此类推(以下标 0 开始)。

POST json 请求:{"Ids": ["app-xxxx", "app-yyyy", "app-zzzz"]}

API 快速入门

这里针对几个典型的使用场景对 TSF API 的使用方式进行说明:

  1. 通过使用 创建应用 API,提供应用名称、应用类型等必要信息,即可创建一个新的微服务应用。
  2. 通过使用 创建部署组 API,选择目标应用和集群,即可创建一个部署组用于管理应用实例。
  3. 通过使用 部署应用 API,选择目标部署组和镜像版本,即可将应用部署到指定环境。
  4. 如需管理配置信息,可以使用 创建配置项 API 将配置信息下发到指定应用。
  5. 如需查看集群运行状态,可以使用 查询集群实例 API 查看应用集群的运行情况。

使用限制

  • API 创建的资源遵循 TSF 产品文档所描述的数量限制,和官网所创建的资源共用配额。
  • 更具体的限制请参考对应 API 接口文档或产品文档。
  • 默认接口请求频率限制请根据具体接口文档说明,超出频率限制时会返回错误码 RequestLimitExceeded
  • TSF 的部分功能需要依赖其他腾讯云产品(如 CVM、TKE、CLB 等),使用时需确保相关产品已开通且资源充足。