You need to enable JavaScript to run this app.
导航

UpdateListener

最近更新时间2022.09.01 11:30:06

首次发布时间2022.09.01 11:30:06

API说明

API 名称:DescribeListeners。
API 域名:open.volcengineapi.com 。
API 描述:更新监听。

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数

名称类型是否必选格式说明
Action
string
[a-zA-Z]+
API 名称。
VersionstringYYYY-MM-DDAPI 版本信息。该参数的取值是 2022-03-01 。

请求正文

在使用该 API 提交请求时,请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例
ListenerId
string
监听ID 。
ga-ghdasgh***
Namestring监听名称。test_phdg
ProtocolString监听协议,具体支持:TCP、UDP。TCP
PortRangesarray of PortRange监听端口。PortRange

EnableAffinity

bool

是否开启客户端亲和性,默认不开启,支持取值:

  • true:开启。
  • false:不开启。

false

PortRange

参数类型参数说明示例值
FromPort
int
起始端口。
80
ToPortint终止端口。81

示例

请求示例

POST https://open.volcengineapi.com/?Version=2022-03-01&Action=UpdateListener&<其他公共请求参数>
{
    "Name": "",
    "Protocol": "UDP",
    "PortRanges": [
        {
            "FromPort": 35,
            "ToPort": 35
        }
    ],
    "EnableAffinity": false,
    "ListenerId": "listener-BBL7ACekxpY94mvkExYwMb"
}