查询接入段加速会话信息

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

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeFirstLinkSession）用于查询接入段加速会话状态，包括会话状态，生效时长，加速套餐等信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFirstLinkSession。
Version	是	String	公共参数，本接口取值：2018-05-29。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-shanghai, ap-singapore 。
SessionId	是	String	单次加速唯一会话Id 示例值：16323902746ebb80e918b94b818a5647fbb0d921f8-3-65537

3. 输出参数

参数名称	类型	描述
Status	Integer	会话状态，具体如下： 1：加速中； 0：非加速中。注意：此字段可能返回 null，表示取不到有效值。示例值：1
Duration	Integer	剩余加速时间，单位秒。注意：此字段可能返回 null，表示取不到有效值。示例值：1790
SuiteType	String	加速套餐类型。套餐说明如下： T100K：上/下行保障100kbps； BD4M：下行带宽保障4Mbps； BU4M：上行带宽保障4Mbps。注意：此字段可能返回 null，表示取不到有效值。示例值：T100K
SrcPublicIpv4	String	加速终端的公网ip 注意：此字段可能返回 null，表示取不到有效值。示例值：211.97.129.234
DestIpv4	Array of String	加速目标ip 注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询接入段加速会话信息

输入示例

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

{
    "SessionId": "MTYzMjczNDYyNDU0MWE5OWY3MWMzYTQ3OGZhMjJkY2NlNDU0NDE2YzE3-3-65537"
}

输出示例

{
    "Response": {
        "Status": 1,
        "DestIpv4": [
            "143.244.174.31"
        ],
        "Duration": 1771,
        "SuiteType": "T100K",
        "RequestId": "q708a7c6-db58-4729-8e09-2ea6b727109p",
        "SrcPublicIpv4": "211.97.129.234"
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization	非企业认证客户。
AuthFailure.UnauthorizedOperation	子账户未授权操作。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation	操作失败。
FailedOperation.VendorReturnError	运营商返回结果错误。
FailedOperation.VendorServerError	运营商服务器临时错误。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

上一篇: 删除接入段加速会话下一篇: 添加源站