获取应用列表

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

1. 接口描述

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

获取应用列表

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

接口更新时间：2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeApplications
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Limit	否	否	Int64	分页个数示例值：
ApplicationType	否	否	String	应用类型示例值：
MicroserviceType	否	否	String	应用的微服务类型示例值：
ApplicationResourceTypeList	否	否	Array of String	应用资源类型数组示例值：
ApplicationIdList	否	否	Array of String	IdList 示例值：
OrderBy	否	否	String	排序字段示例值：
MicroserviceTypeList	否	是	Array of String	查询多种微服务类型的应用示例值：
SearchWord	否	否	String	搜索字段示例值：
OrderType	否	否	Int64	排序类型示例值：
Offset	否	否	Int64	偏移量示例值：

3. 输出参数

参数名称	类型	描述
Result	TsfPageApplication	应用分页列表信息示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter.ParamError	参数错误。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.ApplicationQueryFailed	应用查询失败。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.UnhandledException	[%s]模块未处理异常。。
InvalidParameterValue.ApplicationPageLimitInvalid	无效的应用分页参数。
ResourceNotFound.LicenseServerNotFound	无法找到License服务器。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense	缺少License。。
InvalidParameterValue.ApplicationOrderTypeInvalid	无效的应用排序类型。
FailedOperation.DispatchCommonError	TSF暂时不能响应请求。
FailedOperation.UnhandledException	模块未处理异常。

5. 示例

示例1 查询应用列表示例

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=DescribeApplications
&Offset=0
&Limit=20
&SearchWord=driverapi
&<Common Parameters>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "Content": [{
                "ApplicationId": "application-6a79x94v",
                "ApplicationName": "application-test-name",
                "ApplicationDesc": "this is a desc",
                "ApplicationType": "C",
                "MicroserviceType": "DEF",
                "ProgLang": "J",
                "CreateTime": "2020-11-22 09:16:12",
                "UpdateTime": "2021-11-22 09:16:12",
                "ApplicationResourceType": "C",
                "ApplicationRuntimeType": "JDK8",
                "ApigatewayServiceId": "ms-6a79x94v",
                "ApplicationRemarkName": "this is a remack name",
                "ServiceConfigList": [{
                    "Name": "service-config-name",
                    "Ports": [{
                        "TargetPort": "8080",
                        "Protocol": "8080"
                    }],
                    "HealthCheck": {
                        "Path": "/health"
                    }
                }],
                "IgnoreCreateImageRepository": true,
                "ApmInstanceId": "apm-6a79x94v",
                "ApmInstanceName": "apm-test-name",
                "SyncDeleteImageRepository": true,
                "MicroserviceSubType": "N",
                "ProgramLanguage": "Java",
                "FrameworkType": "Spring Cloud",
                "ServiceGovernanceConfig": {
                    "EnableGovernance": true,
                    "GovernanceType": "Share",
                    "ExclusiveInstances": [{
                        "CenterType": "Config",
                        "InstanceId": "ins-6a79x94v",
                        "InstanceType": "polaris",
                        "InstanceName": "test-name",
                        "RegionId": "ap-gz",
                        "InstanceNamespaceId": "ns-6a79x94v"
                    }]
                },
                "MicroserviceTypeList": ["N"],
                "CreateSameNameImageRepository": true
            }]
        },
        "RequestId": "96561cf1-738a-47d6-943b-dec7ebbccabe"
    }
}