有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(CheckProxyCreate)用于查询能否创建指定配置的加速通道。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CheckProxyCreate。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,此参数为可选参数。
AccessRegion String 通道的接入(加速)区域。取值可通过接口DescribeAccessRegionsByDestRegion获取到
示例值:EastChina
RealServerRegion String 通道的源站区域。取值可通过接口DescribeDestRegions获取到
示例值:SouthChina
Bandwidth Integer 通道带宽上限,单位:Mbps。
示例值:10
Concurrent Integer 通道并发量上限,表示同时在线的连接数,单位:万。
示例值:2
GroupId String 如果在通道组下创建通道,需要填写通道组的ID
示例值:""
IPAddressVersion String IP版本,可取值:IPv4、IPv6,默认值IPv4
示例值:IPv4
NetworkType String 网络类型,可取值:normal、cn2,默认值normal
示例值:normal
PackageType String 通道套餐类型。Thunder表示标准通道组,Accelerator表示游戏加速器通道,CrossBorder表示跨境通道。
示例值:Thunder
Http3Supported Integer 该字段已废弃,当IPAddressVersion为IPv4时,所创建的通道默认支持Http3.0;当为IPv6,默认不支持Http3.0。
示例值:0

3. 输出参数

参数名称 类型 描述
CheckFlag Integer 查询能否创建给定配置的通道,1可以创建,0不可创建。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询通道是否可以创建

输入示例

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

{
    "Concurrent": "2",
    "Bandwidth": "10",
    "RealServerRegion": "SouthChina",
    "AccessRegion": "EastChina"
}

输出示例

{
    "Response": {
        "CheckFlag": 1,
        "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
AuthFailure.UnauthorizedOperation 子账户未授权操作。
FailedOperation 操作失败。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidBandwidth 带宽值不在可选范围内。
InvalidParameterValue.InvalidConcurrency 并发量值不在可选范围内。
InvalidParameterValue.UnknownAccessRegion 未找到或无权限访问的加速区域。
InvalidParameterValue.UnknownDestRegion 未找到或无权限访问的源站区域。
MissingParameter 缺少参数错误。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。