创建接入段加速会话

最近更新时间:2024-03-12 01:31:56

我的收藏

1. 接口描述

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

本接口(CreateFirstLinkSession)用于创建接入段加速会话,创建有可能成功,也可能失败,需要通过返回码来进行判断。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateFirstLinkSession。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-shanghai, ap-singapore 。
TemplateId String 模版ID
示例值:flt-12345678
SrcAddressInfo SrcAddressInfo 终端网络信息
DestAddressInfo DestAddressInfo 加速目标网络信息
DeviceInfo DeviceInfo 终端设备信息
Capacity Capacity 接口扩展参数,如果是电信用户,需要填充CTCC Token字段

3. 输出参数

参数名称 类型 描述
SessionId String 加速成功时返回,单次加速唯一会话Id。。
注意:此字段可能返回 null,表示取不到有效值。
示例值:16323902746ebb80e918b94b818a5647fbb0d921f8-3-65537
Duration Integer 剩余的加速时间,单位秒。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1790
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建接入段加速会话

输入示例

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

{
    "TemplateId": "flt-4av6kul7",
    "DestAddressInfo": {
        "DestIp": [
            "143.244.174.31"
        ]
    },
    "SrcAddressInfo": {
        "SrcIpv4": "10.51.105.127",
        "SrcPublicIpv4": "211.97.128.200"
    }
}

输出示例

{
    "Response": {
        "SessionId": "ZWViYzAwNzJmNjRkNGExMDgyMjkzZTY0YzU0ZjZhNDY=-1-0",
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "Duration": 1790
    }
}

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.CTCCTokenExpired 中国电信加速token过期。
FailedOperation.CreateQosExceedLimit 相同加速间隔时间过短。
FailedOperation.IPUnmatched 加速目标IP与绑定的通道IP不匹配。
FailedOperation.NoResourceBound 该应用模版没有绑定通道。
FailedOperation.RequestVendorTimeout 请求运营商超时。
FailedOperation.ResourceNotFound 应用ID填写有误,请检查应用ID是否存在。
FailedOperation.SessionNotExist Session不存在或已经被取消。
FailedOperation.UserOutOfCoverage 该用户不在运营商网络可加速范围内。
FailedOperation.VendorReturnError 运营商返回结果错误。
FailedOperation.VendorServerError 运营商服务器临时错误。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。