ModifyDomainAttributes

最近更新时间: 2024-12-21 13:01:31

1. 接口描述

接口请求域名: clb.api3.gsesgpucloud.com。

ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性,如修改域名、修改DefaultServer、开启/关闭Http2、修改证书。 本接口为异步接口,本接口返回成功后,需以返回的RequestId为入参,调用DescribeTaskStatus接口查询本次任务是否成功。

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

接口更新时间:2021-04-06 21:40:04。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:ModifyDomainAttributes
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
LoadBalancerId String 负载均衡实例 ID
示例值: lb-1wvl****
ListenerId String 负载均衡监听器 ID
示例值: lbl-n8mb****
Domain String 域名(必须是已经创建的转发规则下的域名)
示例值: foo.net
NewDomain String 要修改的新域名
示例值: www.new.example.com
Certificate CertificateInput 域名相关的证书信息,注意,仅对启用SNI的监听器适用。
示例值:查看
Http2 Bool 是否开启Http2,注意,只有HTTPS域名才能开启Http2。1表示开启,0表示不开启
示例值: true
DefaultServer Bool 是否设为默认域名,注意,一个监听器下只能设置一个默认域名。true表示设置为默认域名,0表示不设置
示例值: true
NewDefaultServerDomain String 监听器下必须配置一个默认域名,若要关闭原默认域名,必须同时指定另一个域名作为新的默认域名。
示例值: www.qcloud.example.com

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误
UnauthorizedOperation 未授权操作
InvalidParameterValue.Length 参数长度错误。
MissingParameter 缺少参数错误。
FailedOperation 操作失败
InternalError 内部错误