创建通道

最近更新时间:2024-10-30 01:36:45

我的收藏

1. 接口描述

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

本接口(CreateProxy)用于创建/复制一个指定配置的加速通道。当复制通道时,需要设置新通道的基本配置参数,并设置ClonedProxyId来指定被复制的通道。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateProxy。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,此参数为可选参数。
ProjectId Integer 通道的项目ID。
示例值:0
ProxyName String 通道名称。
示例值:test
AccessRegion String 接入地域。
示例值:GuangZhou
Bandwidth Integer 通道带宽上限,单位:Mbps。
示例值:10
Concurrent Integer 通道并发量上限,表示同时在线的连接数,单位:万。
示例值:2
RealServerRegion String 源站地域。当GroupId存在时,源站地域为通道组的源站地域,此时可不填该字段。当GroupId不存在时,需要填写该字段
示例值:Hongkong
ClientToken String 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
更多详细信息请参阅:如何保证幂等性。
示例值:""
GroupId String 通道所在的通道组ID,当在通道组中创建通道时必带,否则忽略该字段。
示例值:lg-2sczm0nv
TagSet.N Array of TagPair 通道需要添加的标签列表。
ClonedProxyId String 被复制的通道ID。只有处于运行中状态的通道可以被复制。
当设置该参数时,表示复制该通道。
示例值:link-nphqtout
BillingType Integer 计费方式 (0:按带宽计费,1:按流量计费 默认按带宽计费)
示例值:0
IPAddressVersion String IP版本,可取值:IPv4、IPv6,默认值IPv4
示例值:IPv4
NetworkType String 网络类型,normal表示常规BGP,cn2表示精品BGP,triple表示三网
示例值:normal
PackageType String 通道套餐类型,Thunder表示标准通道组,Accelerator表示游戏加速器通道,CrossBorder表示跨境通道。
示例值:Thunder
Http3Supported Integer 该字段已废弃,当IPAddressVersion为IPv4时,所创建的通道默认支持Http3.0;当为IPv6,默认不支持Http3.0。
示例值:0

3. 输出参数

参数名称 类型 描述
InstanceId String 通道的实例ID。
示例值:link-11112222
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建通道2

输入示例

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

{
    "ProjectId": 0,
    "ProxyName": "test",
    "AccessRegion": "Hongkong",
    "Bandwidth": 10,
    "Concurrent": 2,
    "RealServerRegion": "Shanghai",
    "TagSet": [],
    "BillingType": 1,
    "IPAddressVersion": "IPv4",
    "NetworkType": "normal",
    "PackageType": "Thunder",
    "Http3Supported": 0
}

输出示例

{
    "Response": {
        "RequestId": "db2dd9d4-ba60-48a2-a9ed-cd18c6e58dd0",
        "InstanceId": "link-nphqtout"
    }
}

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.AccountBalanceInsufficient 账户余额不足,无法创建该通道。
FailedOperation.DuplicatedRequest 重复的请求,请检查ClientToken的值。
FailedOperation.LimitNumofListener 监听器数量超过限制。
FailedOperation.ProxySellOut 线路售罄或资源不足,请提工单申请。
FailedOperation.TagResourcesFailed 标签资源绑定失败。
FailedOperation.UnTagResourcesFailed 标签资源解绑失败。
FailedOperation.UserNotAuthenticated 用户未认证。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.FeatureConflict 无法同时开启所设置的特性。
InvalidParameterValue.InvalidBandwidth 带宽值不在可选范围内。
InvalidParameterValue.InvalidConcurrency 并发量值不在可选范围内。
InvalidParameterValue.InvalidTags 未找到或无权限访问该标签
InvalidParameterValue.ProjectIdNotBelong 项目不属于该用户。
InvalidParameterValue.ProxyAndGroupFeatureConflict 该通道组下无法支持该通道所需的特性。
InvalidParameterValue.ProxyAndRegionFeatureConflict 该地区不支持通道所设置的特性。
LimitExceeded.TagQuota 标签配额不足。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。