启用或禁用API

最近更新时间:2025-04-25 02:06:53

我的收藏

1. 接口描述

接口请求域名: tsf.tencentcloudapi.com 。

启用或禁用API

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ChangeApiUsableStatus。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
ApiId String API ID
示例值:api-m42wysh0
UsableStatus String 切换状态,enabled/disabled
示例值:enabled

3. 输出参数

参数名称 类型 描述
Result ApiDetailInfo API 信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 启用API

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChangeApiUsableStatus
<公共请求参数>

{
    "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"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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