云开发 CloudBase 查看安全网关-其他接口-API 中心-腾讯云

1. 接口描述

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

查看安全网关

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeWxGateways。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境ID 示例值：lotestapi100004
GatewayId	否	String	网关ID 示例值：gatewayid-xxx
GatewayName	否	String	服务名称，精确匹配示例值：gateway-test
Limit	否	Integer	分页参数示例值：0
Offset	否	Integer	分页参数示例值：0

3. 输出参数

参数名称	类型	描述
Gateways	Array of GatewayItem	返回的服务列表
TotalCount	Integer	网关总数示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看安全网关

输入示例

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

{
    "EnvId": "lotestapi100004"
}

输出示例

{
    "Response": {
        "Gateways": [
            {
                "AccessDomain": "",
                "AllowUncertified": 0,
                "AppId": 0,
                "AutoRenewFlag": 1,
                "CanDowngrade": false,
                "CanRenew": true,
                "CreateTime": "2023-11-23 10:27:31",
                "EnvId": "envid-xxx",
                "ExpireTime": "2024-12-23 23:59:59",
                "GatewayDesc": "",
                "GatewayId": "envid-xxx",
                "GatewayName": "gatewayname-xxx",
                "GatewayType": "wechat",
                "IsolateTime": "0000-00-00 00:00:00",
                "L5Addr": "",
                "LongAccessId": "",
                "PackageId": 2005,
                "PackageVersion": "testV2",
                "Region": "ap-shanghai",
                "Status": "success",
                "SubnetIds": [
                    "subnet-xxxx"
                ],
                "Uin": "100008561789",
                "UpdateTime": "2024-04-25 10:50:13",
                "VersionNumLimit": 3,
                "VpcId": "vpcid-xxxx",
                "WxAppId": "wxappid-xxxx"
            }
        ],
        "RequestId": "",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。