修改负载均衡七层监听器转发规则的域名级别属性

最近更新时间：2023-09-21 02:00:01

我的收藏

本页目录：

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyDomainAttributes。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表。
LoadBalancerId	是	String	负载均衡实例ID。示例值：lb-1wvl****
ListenerId	是	String	负载均衡监听器ID。示例值：lbl-n8mb****
Domain	是	String	域名（必须是已经创建的转发规则下的域名），如果是多域名，可以指定多域名列表中的任意一个。示例值：foo.net
NewDomain	否	String	要修改的新域名。NewDomain和NewDomains只能传一个。示例值：www.new.example.com
Certificate	否	CertificateInput	域名相关的证书信息，注意，仅对启用SNI的监听器适用，不可和MultiCertInfo 同时传入。
Http2	否	Boolean	是否开启Http2，注意，只有HTTPS域名才能开启Http2。示例值：true
DefaultServer	否	Boolean	是否设为默认域名，注意，一个监听器下只能设置一个默认域名。示例值：true
Quic	否	Boolean	是否开启Quic，注意，只有HTTPS域名才能开启Quic 示例值：true
NewDefaultServerDomain	否	String	监听器下必须配置一个默认域名，若要关闭原默认域名，必须同时指定另一个域名作为新的默认域名，如果新的默认域名是多域名，可以指定多域名列表中的任意一个。示例值：www.qcloud.example.com
NewDomains.N	否	Array of String	要修改的新域名列表。NewDomain和NewDomains只能传一个。示例值：["www.new.example.com"]
MultiCertInfo	否	MultiCertInfo	域名相关的证书信息，注意，仅对启用SNI的监听器适用；支持同时传入多本算法类型不同的服务器证书，不可和MultiCertInfo 同时传入。

3. 输出参数

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

4. 示例

示例1 修改七层监听器下域名的相关属性

修改七层监听器下域名的相关属性

输入示例

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

{
    "Domain": "foo.net",
    "ListenerId": "lbl-n8mb2r3a",
    "LoadBalancerId": "lb-1wvl0ejw"
}

输出示例

{
    "Response": {
        "RequestId": "db141822-c025-4765-88d4-02bdec0e67ed"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

上一篇: 修改七层转发规则的域名下一篇: 删除负载均衡监听器