最近更新时间:2022.09.01 11:30:06
首次发布时间:2022.09.01 11:30:06
API 名称:DescribeListeners。
API 域名:open.volcengineapi.com 。
API 描述:更新监听。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数。
名称 | 类型 | 是否必选 | 格式 | 说明 |
---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称。 |
Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2022-03-01 。 |
在使用该 API 提交请求时,请求正文中可以包含的参数如下。
参数 | 类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
ListenerId | string | 是 | 监听ID 。 | ga-ghdasgh*** |
Name | string | 否 | 监听名称。 | test_phdg |
Protocol | String | 否 | 监听协议,具体支持:TCP、UDP。 | TCP |
PortRanges | array of PortRange | 否 | 监听端口。 | 见 PortRange |
EnableAffinity | bool | 否 | 是否开启客户端亲和性,默认不开启,支持取值:
| false |
PortRange
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
FromPort | int | 起始端口。 | 80 |
ToPort | int | 终止端口。 | 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" }