查询简单命名空间列表

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

1. 接口描述

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

查询简单命名空间列表

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

接口更新时间:2026-02-06 14:37:23。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:DescribeSimpleNamespaces
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
Limit 否 否 Int64 分页个数,默认为20, 取值应为1~100
示例值:  
Offset 否 否 Int64 偏移量,取值从0开始
示例值:  
NamespaceId 否 否 String 命名空间ID,按照【命名空间ID】进行过滤,可通过调用DescribeNamespaces查询已创建的项目列表或登录控制台进行查看;也可以调用CreateNamespace创建新的项目。命名空间ID例如:namespace-6a79x94v。
示例值:  
NamespaceResourceTypeList 否 否 Array of String 查询资源类型列表
示例值:  
NamespaceTypeList 否 否 Array of String 查询的命名空间类型列表。DEF:默认普通命名空间。GLOBAL:全局命名空间
示例值:  
NamespaceName 否 否 String 通过命名空间名精确过滤
示例值:  
IsDefault 否 否 String 通过是否是默认命名空间过滤,不传表示拉取全部命名空间。0:默认命名空间。1:非默认命名空间
示例值:  
DisableProgramAuthCheck 否 否 Bool 是否关闭鉴权查询
示例值:  
NamespaceIdList 否 否 Array of String 命名空间ID列表,按照【命名空间ID列表】进行过滤,可通过调用DescribeNamespaces查询已创建的项目列表或登录控制台进行查看;也可以调用CreateNamespace创建新的项目。
示例值:  
ClusterId 否 否 String 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateClusters创建新的项目。集群ID例如:cls-6a79x94v。仅在集群下无部署组、命名空间、云主机时可以删除。
示例值:  
SearchWord 否 否 String 通过id和name进行过滤
示例值:  

3. 输出参数

参数名称 类型 描述
Result TsfPageNamespace 命名空间分页列表
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter.ParamError 参数错误。
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
FailedOperation.ClusterQueryFailed 查询集群失败。
FailedOperation.NamespaceQueryFailed 命名空间查询失败。
FailedOperation.TsfPrivilegeError TSF权限模块异常,请联系系统管理员。。
InternalError.UnhandledException [%s]模块未处理异常。。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense 缺少License。。
AuthFailure.UnauthorizedOperation 用户无权限访问该接口。。

5. 示例

示例1 查询简单命名空间列表

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=DescribeSimpleNamespaces
&Offset=0
&Limit=50
&<Common Parameters>

输出示例

{
  "Response": {
    "RequestId": "44c883b4-9500-43f1-bd42-5bdbfcd5d3f5",
    "Result": {
      "TotalCount": 0,
      "Content": []
    }
  }
}