全球应用加速
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>全球应用加速>API 文档>监听器相关接口>创建UDP监听器

创建UDP监听器

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

我的收藏

本页目录：

1. 接口描述

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

该接口（CreateUDPListeners）用于批量创建单通道或者通道组的UDP协议类型的监听器。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateUDPListeners。
Version 是 String 公共参数，本接口取值：2018-05-29。
Region 否 String 公共参数，此参数为可选参数。
ListenerName 是 String 监听器名称
示例值：test1
Ports.N 是 Array of Integer 监听器端口列表
示例值：["90\n"]
Scheduler 是 String 监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。
示例值：rr
RealServerType 是 String 监听器绑定源站类型。IP表示IP地址，DOMAIN表示域名。
示例值：IP
ProxyId 否 String 通道ID，ProxyId和GroupId必须设置一个，但不能同时设置。
示例值：link-bjkpdum1
GroupId 否 String 通道组ID，ProxyId和GroupId必须设置一个，但不能同时设置。
示例值：lg-xxxx
RealServerPorts.N 否 Array of Integer 源站端口列表，该参数仅支持v1版本监听器和通道组监听器
示例值：[80]
DelayLoop 否 Integer 源站健康检查时间间隔，单位：秒。时间间隔取值在[5，300]之间。
示例值：20
ConnectTimeout 否 Integer 源站健康检查响应超时时间，单位：秒。超时时间取值在[2，60]之间。超时时间应小于健康检查时间间隔DelayLoop。
示例值：20
HealthyThreshold 否 Integer 健康阈值，表示连续检查成功多少次后认定源站健康。范围为1到10
示例值：5
UnhealthyThreshold 否 Integer 不健康阈值，表示连续检查失败多少次数后认为源站不健康。范围为1到10
示例值：1
FailoverSwitch 否 Integer 源站是否开启主备模式：1开启，0关闭，DOMAIN类型源站不支持开启
示例值：0
HealthCheck 否 Integer 源站是否开启健康检查：1开启，0关闭。
示例值：1
CheckType 否 String UDP源站健康类型。PORT表示检查端口，PING表示PING。
示例值：PING
CheckPort 否 Integer UDP源站健康检查探测端口。
示例值：8888
ContextType 否 String UDP源站健康检查端口探测报文类型：TEXT表示文本。仅在健康检查类型为PORT时使用。
示例值：TEXT
SendContext 否 String UDP源站健康检查端口探测发送报文。仅在健康检查类型为PORT时使用。
示例值：helloworld
RecvContext 否 String UDP源站健康检查端口探测接收报文。仅在健康检查类型为PORT时使用。
示例值：helloworld

3. 输出参数

参数名称 类型 描述
ListenerIds Array of String 返回监听器ID
示例值：["listener-o0f3at99"]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建UDP监听器

创建UDP监听器

输入示例

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

{
    "ProxyId": "link-bjkpdum1",
    "RealServerType": "IP",
    "ListenerName": "test1",
    "Scheduler": "rr",
    "Ports": [
        "90"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "9aeda369-17c7-429f-be39-745c1e92fc71",
        "ListenerIds": [
            "listener-o0f3at99"
        ]
    }
}

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.GroupStatusNotInRuning 通道组状态为非运行状态，无法操作。
FailedOperation.InstanceStatusNotInRuning 通道状态为非运行状态，无法操作。
FailedOperation.LimitNumofListener 监听器数量超过限制。
FailedOperation.ListenerHasTask 监听器正在操作中，请勿重复操作。
FailedOperation.NonStandardProxy 该通道为非标通道，限制所有写操作。
FailedOperation.OperateLimitNumofListener 单次操作端口过多，超过数量上限。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DuplicatedListenerPort 监听器端口已存在。
InvalidParameterValue.InvalidListenerPort 该监听器端口不可用。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.AccountViolation 账号下存在违规资源，详情请查看站内信或邮件。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。
中国站
文档反馈
文档活动
message-icon联系我们
目录