查询API分组

最近更新时间: 2026-09-17 00:03:59

1. 接口描述

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

查询API分组

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

接口更新时间：2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeApiGroup
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId	是	否	String	API 分组ID 示例值：

3. 输出参数

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

4. 错误码

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

错误码	描述
InvalidParameterValue.GatewayParameterInvalid	无效请求参数:%s。
MissingParameter.GatewayParameterRequired	缺少请求参数:%s。
InternalError.GatewayDbError	网关数据异常。

5. 示例

示例1 查询API分组

输入示例

POST / HTTP/1.1
Host: tsf.api3.<no value>
Content-Type: application/json
X-TC-Action: DescribeApiGroup
<公共请求参数>

{
    "GroupId": "grp-e42d597"
}

输出示例

{
    "Response": {
        "Result": {
            "Status": "xx", 
            "UpdatedTime": "xx", 
            "AuthType": "secret", 
            "Description": "xx", 
            "BindedGatewayDeployGroups": [
                {
                    "DeployGroupId": "grp-fdsfds", 
                    "ApplicationName": "xx", 
                    "GroupStatus": "drafted", 
                    "ClusterType": "xx", 
                    "DeployGroupName": "xx", 
                    "ApplicationType": "xx", 
                    "ApplicationId": "xx"
                }
            ], 
            "GroupType": "ms", 
            "AclMode": "xx", 
            "ApiCount": 0, 
            "GroupName": "xx", 
            "GroupContext": "/xx", 
            "CreatedTime": "xx", 
            "GroupId": "grp-dasdasdas"
        }, 
        "RequestId": "5d996e05507e42d5970cd2e25ed5267a"
    }
}