启用或禁用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	公共参数，本接口取值：ChangeApiUsableStatus
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ApiId	是	否	String	API ID 示例值：
UsableStatus	是	否	String	切换状态，enabled/disabled 示例值：

3. 输出参数

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

4. 错误码

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

错误码	描述
UnauthorizedOperation.LicenseUnauthorized	您所购买的服务不支持该操作。

5. 示例

示例1 启用API

输入示例

https://tsf.api3.<no value>/?Action=ChangeApiUsableStatus
&ApiId=api-d5970cd2
&UsableStatus=enabled
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "UpdatedTime": "xx", 
            "PathMapping": "xx", 
            "MicroserviceName": "xx", 
            "Description": "xx", 
            "MicroserviceId": "xx", 
            "NamespaceName": "xx", 
            "ApiId": "api-d5970cd2", 
            "UsableStatus": "xx", 
            "ApiType": "xx", 
            "ReleaseStatus": "xx", 
            "GroupName": "xx", 
            "Host": "xx", 
            "Method": "POST", 
            "RateLimitStatus": "xx", 
            "Timeout": 10, 
            "NamespaceId": "xx", 
            "CreatedTime": "xx", 
            "Path": "/provider-demo/v1/echo", 
            "ReleasedTime": "xx", 
            "MockStatus": "xx", 
            "GroupId": "xx"
        }, 
        "RequestId": "5d996e5507e42d5970cd2e25ed5267a"
    }
}