启用或禁用API

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

1. 接口描述

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

启用或禁用API

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

接口更新时间：2026-05-20 22:49:11。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：ChangeApiUsableStatus
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ApiId 是 否 String API ID
示例值： api-2jsjges9
UsableStatus 是 否 String 切换状态，enabled/disabled
示例值： enable

3. 输出参数

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

4. 错误码

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

错误码 描述
UnauthorizedOperation.LicenseUnauthorized 您所购买的服务不支持该操作。
InvalidParameterValue.GatewayParameterInvalid 无效请求参数:%s。

5. 示例

示例1 启用API

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: ChangeApiUsableStatus
<Common Parameters>

{
  "ApiId": "api-m42wysh0",
  "UsableStatus": "enabled"
}

输出示例

{
  "Response": {
    "RequestId": "1e248975-03fa-4ce6-ab7b-71e022859221",
    "Result": {
      "ApiId": "api-m42wysh0",
      "ApiMatchType": "normal",
      "ApiType": "external",
      "CreatedTime": "2024-12-11 18:08:38",
      "Description": null,
      "GatewayDeployGroupId": null,
      "GroupId": "grp-h9xl5mmi",
      "GroupName": null,
      "Host": "http://test.com",
      "Md5": "39c57c50b244de7272311253edca3771",
      "Method": "GET",
      "MicroserviceId": "ms-external",
      "MicroserviceName": "ms-external",
      "MockStatus": "disabled",
      "NamespaceId": "namespace-external",
      "NamespaceName": "namespace-external",
      "Path": "/healthcheck",
      "PathMapping": "/health",
      "RateLimitStatus": null,
      "ReleaseStatus": "released",
      "ReleasedTime": null,
      "RpcExt": null,
      "RpcType": "http",
      "Timeout": null,
      "UpdatedTime": "2024-12-18 11:49:22",
      "UsableStatus": "enabled"
    }
  }
}