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

ModifyListenerAttributes

最近更新时间2024.02.29 14:48:16

首次发布时间2022.05.20 21:49:43

API 说明

API 名称:ModifyListenerAttributes。
API 域名:open.volcengineapi.com 。
API 描述:修改指定监听器。

使用限制

节流限制:每秒最多提交 5 个 API 请求。

快速调试

URI 参数

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

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

名称类型是否必选格式说明
Action
string
[a-zA-Z]+
API 名称,如 ModifyListenerAttributes 。
VersionstringYYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint900表示签名的有效时间,单位是秒,默认值是900。

请求正文

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

参数类型是否必选参数说明示例值
ListenerIdString待修改的监听器 ID。lsn-abc*******

ListenerName

String

监听器的名字。

  • 不能以http://或https://开头。
  • 必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。
  • 长度限制在1-128字符之间。

test

Enabled

String

监听器开启/关闭,取值如下:

  • on:开启。
  • off:关闭。

on

CertificateIdString监听器关联的证书 ID,创建 HTTPS 监听器必传。cert-******
CACertificateIdString监听器关联的CA证书 ID,创建 HTTPS 监听器时指定 CA 证书,则支持双向认证,否则为单向认证。cert-******
ServerGroupIdString监听器关联的默认服务器组 ID 。rsp-******

EnableHttp2

String

HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:

  • on:开启。
  • off:关闭。

off

EnableQuic

String

QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:

  • on:开启。
  • off:关闭。

off

CustomizedCfgId

String

绑定个性化配置。

  • 只能绑定 Active 状态的个性化配置。
  • 要删除个性化配置时设置该字段为空字符串。不传该参数时不做修改。

ccfg-*****

AclStatus

String

  • 是否开启访问控制功能。取值如下:
    • on:开启。
    • off :不开启。
  • 不填表示不修改访问控制相关信息。
  • 配置本参数后会清空已配置的AclType和AclIds参数。
  • 如果将本参数值从 on 修改为 off,将清空AclType和AclIds参数中的值。
  • 如果将本参数值从 off 修改为 on,则必须同时设置AclType和AclIds参数的值。

off

AclType

String

访问控制的方式。取值如下:

  • white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。
  • black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP,则监听器会转发全部请求。
    当AclStatus参数配置为 on 时,AclType和AclIds.N为必填。

black

AclIds.N

List of String

监听器绑定的访问控制策略组ID。

  • - N:表示访问控制策略组的序号,数量上限为5个。
  • 多个访问控制策略组ID间使用“&”分隔。
    当AclStatus参数配置为 on 时,AclType和AclIds.N为必填。
AclIds.1=acl-3cj44nv0jhhxc6c6rrtet****& AclIds.2=acl-2febxt4pu0zy85oxruw0t****

Description

String

监听器的描述信息。

  • 不能以http://或https://开头。
  • 必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。
  • 长度限制为1 ~ 255个字符。

test

DomainExtensions-HTTPS监听器关联的扩展域名列表,具体请参见下表 DomainExtensions-

DomainExtensions

参数类型是否必选参数说明示例值
DomainExtensions.N.DomainExtensionId
List of Struct
扩展域名ID,仅删除和修改时需要指定。 - N:表示域名的序号,一个HTTPS监听器能关联的扩展域名上限为20个。
DomainExtensions.1.DomainExtensionId=dc-qwertasdf&DomainExtensions.2.DomainExtensionId=dc-poiuylkjhg
DomainExtensions.N.Domain
List of Struct

域名。 - N:表示域名的序号,一个HTTPS监听器能关联的扩展域名上限为20个。 格式规范具体如下:

  • 不能为空。
  • 需至少包含一个‘.’,且不允许以‘.’开头或结尾。
  • 仅允许包含字母、数字、‘.’、‘-‘、‘*’。
  • 长度限制为1 ~ 128个字符。
  • 泛域名:使用“*”代替1个或多个字符。
    • “*”必须在域名开头或结尾。
    • 同一条域名中“*”不能出现两次。
    • “*”前后不能有除了.以外的字符。
    • 合法示例:*.com、www.test.*。
    • 非法示例:*aaa.com、www.*.com
  • 精确域名:符合域名规范的精确域名,例如:www.test.com。
  • 同一HTTPS监听器下的域名不能重复。
DomainExtensions.1.Domain=abc.com&DomainExtensions.2.Domain=def.com
DomainExtensions.N.CertificateId
List of Struct
域名使用的服务器证书。 - N:表示域名的序号,一个HTTPS监听器能关联的扩展域名上限为20个。
DomainExtensions.1.CertificateId=cert-qwertyuqwert&DomainExtensions.2.CertificateId=cert-zxcvbgasdfn
DomainExtensions.N.Action
List of Struct

对指定扩展域名的操作,- N:表示域名的序号,一个HTTPS监听器能关联的扩展域名上限为20个。支持:

  • create(新增)。
  • modify(修改)。
  • delete(删除)。
DomainExtensions.1.Action=add&DomainExtensions.2.Action=modify

响应正文

参数类型参数说明示例值
RequestId
String
请求 ID 。
20210811152539010225146063030****

示例

请求示例

GET /?Action=ModifyListenerAttributes&ListenerId=lsn-2fek3rgsxhrsw5oxruwec****&Version=2020-04-01&ListenerName=test&Enabled=off HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "ModifyListenerAttributes",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202108161106****22514606306AF947C",
    }
}

错误码

如果响应正文包含 Error 字段,则表示 API 请求失败。此处仅展示当前 API 的错误码,更多错误码请参见公共错误码

HTTP Code

错误码

错误信息

错误描述

400OperationDenied.AccountArrearsThe request on the specified resource is denied due to the account being in arrears status.因账号处于欠费状态,对于该资源的操作请求被拒绝。

400

InvalidListenerName.Malformed

The specified ListenerName is malformed.

指定的 ListenerName 参数格式不合法。

400InvalidDescription.MalformedThe specified Description is malformed.指定的 Description 参数格式不合法。

400

InvalidServerGroup.InvalidStatus

The specified ServerGroup is not in the correct status for the request.

指定的服务器组所处状态无法响应该请求。

400InvalidVpcForServerGroup.LoadBalancerMismatchThe specified VPC of ServerGroup and LoadBalancer do not match.指定的服务器组和 ALB 实例的 VPC 不匹配。

400

InvalidCertificateType.FunctionMismatch

The specified Certificate's type and Function do not match.

指定的证书的类型与预期功能不匹配。

400InvalidServerCertificate.InvalidStatusThe specified Server Certificate is not in the correct status for the request.指定的服务器证书所处状态无法响应该请求。
400InvalidCACertificate.InvalidStatusThe specified CA Certificate is not in the correct status for the request.指定的 CA 证书所处状态无法响应该请求。
400InvalidEnableHttp2.MalformedThe specified EnableHttp2 is malformed.指定的 EnableHttp2 参数格式不合法。
400InvalidEnableQuic.MalformedThe specified EnableQuic is malformed.指定的 EnableQuic 参数格式不合法。

400

OperationDenied.DualStackEnableQuicUnsupported

The request on the specified Listener is denied due to the dual stack load balancer listener not support to enable quic.

因双栈 ALB 实例暂时不支持监听器开启 Quic,对于该监听器的操作请求被拒绝。

400InvalidIndexOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。

400

InvalidDomainExtensions.Domain.Malformed

The specified DomainExtensions.Domain is malformed.

指定的 DomainExtensions.Domain 参数格式不合法。

400

InvalidDomainExtensions.Domain.Duplicated

The specified DomainExtensions.Domain is duplicated. Domain Extensions in one listener can not be same.

指定的 DomainExtensions.Domain 重复。一个监听器下关联的扩展域名不能重复。

400InvalidDomainExtensions.Certificate.InvalidStatusThe specified DomainExtension Certificate is not in the correct status for the request.指定的扩展域名证书所处状态无法响应该请求。

400

InvalidDomainExtensions.DomainExtensionId.Duplicated

The specified DomainExtensions.DomainExtensionId is duplicated. Only one type domain extension action is supported on one domain extension in one request.

指定的 DomainExtensions.DomainExtensionId 重复。一次请求中指定的扩展域名仅支持一种操作。

400InvalidDomainExtensions.Action.MalformedThe specified DomainExtensions.Action is malformed.指定的 DomainExtensions.Action 参数格式不合法。
400InvalidAclStatus.MalformedThe specified AclStatus is malformed.指定的 AclStatus 参数格式不合法。
400InvalidAclType.MalformedThe specified AclType is malformed.指定的 AclType 参数格式不合法。
400MissingParameterThe request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'AclIds'.该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: AclIds。
400InvalidAclId.DuplicatedThe specified AclId is duplicated.指定的 AclId 重复。
400InvalidCustomizedCfg.InvalidStatusThe specified CustomizedCfg is not in the correct status for the request.指定的个性化配置所处状态无法响应该请求。
400InvalidEnabled.MalformedThe specified Enabled is malformed.指定的 Enabled 参数格式不合法。

400

OperationFailed.OperateGtmFailed

The request on the specified resource failed due to operating gtm failed.

因操作 GTM 实例失败,对于该资源的操作请求失败。

400QuotaExceed.ServerPerInstanceYou've reached the limit on the number of backend servers per ALB you can associate with, resource xxx, usage xx/xx.已达到每个实例可关联的后端服务器的数量上限。资源是xxx,目前已使用xxx,配额为xxx。

400

QuotaExceed.SniDomainPerListener

You've reached the limit on the number of sni domains per listener you can associate with, resource xxx, usage xx/xx.

已达到每个监听器可关联的 sni 域名的数量上限。资源是xxx,目前已使用xxx,配额为xxx。

400QuotaExceed.ListenerPerCustomizedCfgYou've reached the limit on the number of listeners per CustomizedCfg you can associate with, resource xxx, usage xx/xx.已达到每个个性化配置可关联的监听器的数量上限。资源是xxx,目前已使用xxx,配额为xxx。

400

QuotaExceed.AclPerListener

You've reached the limit on the number of ACLs per listener you can associate with, resource xxx, usage xx/xx.

已达到每个监听器可关联的 ACL 的数量上限。资源是xxx,目前已使用xxx,配额为xxx。

400QuotaExceed.ListenerPerAclYou've reached the limit on the number of listeners per ACL you can associate with, resource xxx, usage xx/xx.已达到每个 ACL 可关联的监听器的数量上限。资源是xxx,目前已使用xxx,配额为xxx。
400QuotaExceed.RulePerGroupYou've reached the limit on the number of rules per server group you can associate with, resource xxx, usage xx/xx.已达到每个服务器组可关联转发规则的数量上限。资源是xxx,目前已使用xxx,配额为xxx。
404InvalidListener.NotFoundThe specified Listener does not exist.指定的监听器不存在。

404

InvalidLoadBalancer.NotFound

The specified LoadBalancer does not exist.

指定的 ALB 实例不存在。

404

InvalidServerGroup.NotFound

The specified ServerGroup does not exist.

指定的服务器组不存在。

404InvalidServerCertificate.NotFoundThe specified Server Certificate does not exist.指定的服务器证书不存在。
404InvalidCACertificate.NotFoundThe specified CA Certificate does not exist.指定的 CA 证书不存在。

404

InvalidDomainExtensions.Certificate.NotFound

The specified DomainExtension Certificate does not exist.

指定的扩展域名证书不存在。

404

InvalidDomainExtension.NotFound

The specified Domain Extension does not exist.

指定的扩展域名不存在。

404InvalidAcl.NotFoundThe specified ACL does not exist.指定的 ACL 不存在。
404InvalidCustomizedCfg.NotFoundThe specified CustomizedCfg does not exist.指定的个性化配置不存在。