有奖征文:轻量对象存储LighthouseCOS用户实践> HOT

1. 接口描述

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

本接口(TurnOffStandaloneGateway)用于关闭小租户网关。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TurnOffStandaloneGateway。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
EnvId String 环境ID
示例值:env-test-xxx
GatewayName String 网关名称
示例值:x-tcb-reserved-gw-envoy-demo
ServiceNameList.N Array of String 服务名称列表
示例值:["service-demo"]

3. 输出参数

参数名称 类型 描述
Status String 关闭独立网关状态
示例值:success
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 关闭小租户网关

输入示例

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

{
    "EnvId": "env-test-xxx",
    "GatewayName": "x-tcb-reserved-gw-envoy-demo",
    "ServiceNameList": [
        "service-demo"
    ]
}

输出示例

{
    "Response": {
        "Status": "success",
        "RequestId": "51a33e48-a808-4fe7-8c02-4e7be5245351"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.PartialFailure 部分失败(有一部分操作失败)。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.Action 接口名非法。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。