查询通道是否可以创建

最近更新时间:2019-08-09 19:18:42

1. 接口描述

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CheckProxyCreate
Version String 公共参数,本接口取值:2018-05-29
Region String 公共参数,本接口不需要传递此参数。
AccessRegion String 通道的接入(加速)区域。取值可通过接口DescribeAccessRegionsByDestRegion获取到
RealServerRegion String 通道的源站区域。取值可通过接口DescribeDestRegions获取到
Bandwidth Integer 通道带宽上限,单位:Mbps。
Concurrent Integer 通道并发量上限,表示同时在线的连接数,单位:万。

3. 输出参数

参数名称 类型 描述
CheckFlag Integer 查询能否创建给定配置的通道,1可以创建,0不可创建。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://gaap.tencentcloudapi.com/?Action=CheckProxyCreate
&AccessRegion=EastChina
&RealServerRegion=SouthChina
&Bandwidth=10
&Concurrent=2
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
InvalidParameterValue.InvalidBandwidth 带宽值不在可选范围内。
InvalidParameterValue.InvalidConcurrency 并发量值不在可选范围内。
InvalidParameterValue.UnknownAccessRegion 未知或无权限访问的加速区域。
InvalidParameterValue.UnknownDestRegion 未知或无权限访问的源站区域。
MissingParameter 缺少参数错误