1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.com。
查询API 分组信息列表
默认接口请求频率限制:20次/秒。
接口更新时间:2024-09-14 11:55:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeApiGroups |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| SearchWord | 否 | 否 | String | 搜索关键字 示例值: |
| Offset | 否 | 否 | Int64 | 偏移量,默认为0 示例值: |
| Limit | 否 | 否 | Int64 | 每页条数,默认为20 示例值: |
| GroupType | 否 | 否 | String | 分组类型。 ms: 微服务分组; external:外部Api分组 示例值: |
| AuthType | 否 | 否 | String | 鉴权类型。 secret: 密钥鉴权; none:无鉴权 示例值: |
| Status | 否 | 否 | String | 发布状态, drafted: 未发布。 released: 发布 示例值: |
| OrderBy | 否 | 否 | String | 排序字段:"created_time"或"group_context" 示例值: |
| OrderType | 否 | 否 | Int64 | 排序类型:0(ASC)或1(DESC) 示例值: |
| GatewayInstanceId | 否 | 否 | String | 网关实体ID 示例值: |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageApiGroupInfo | 翻页结构体 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.GatewayParameterInvalid | 无效请求参数:%s。 |
| MissingParameter.GatewayParameterRequired | 缺少请求参数:%s。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。。 |