1. 接口描述
接口请求域名: bmlb.tencentcloudapi.com 。
根据输入参数来修改黑石负载均衡实例的基本配置信息。可能的信息包括负载均衡实例的名称,域名前缀。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyLoadBalancer。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LoadBalancerId | 是 | String | 负载均衡实例ID,可通过接口DescribeLoadBalancers查询。 |
LoadBalancerName | 否 | String | 负载均衡器名称,规则:1-20个英文、汉字、数字、连接线“-”或下划线“_”。 |
DomainPrefix | 否 | String | 域名前缀,负载均衡的域名由用户输入的域名前缀与配置文件中的域名后缀一起组合而成,保证是唯一的域名。规则:1-20个小写英文字母、数字或连接线“-”。内网类型的负载均衡不能配置该字段。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID。该接口为异步任务,可根据本参数调用DescribeLoadBalancerTaskResult接口来查询任务操作结果。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改黑石负载均衡实例的基本配置信息
输入示例
https://bmlb.tencentcloudapi.com/?Action=ModifyLoadBalancer
&LoadBalancerId=lb-q7qoi8cr
&LoadBalancerName=abcd
&DomainPrefix=qqq
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": 2385751,
"RequestId": "9cb9bd13-3db5-4b76-84ab-34b4fae5ef4c"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |