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

ModifyHaVipAttributes

最近更新时间2024.01.10 10:41:30

首次发布时间2022.03.01 09:03:59

调用 ModifyHaVipAttributes 接口,修改指定高可用虚拟IP(HAVIP)的名称和描述。

说明

高可用虚拟IP功能正在邀测中,如需使用该接口,请提交工单或联系客户经理申请。

调用说明

以下可选参数如不配置,则保持原有配置。

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringModifyHaVipAttributes要执行的操作,取值:ModifyHaVipAttributes。
VersionString2020-04-01API版本信息,取值为:2020-04-01。

HaVipId

String

havip-2zeo05qre24nhrqp****

要修改高可用虚拟IP的ID。
您可以调用 DescribeHaVips 接口,查询高可用虚拟IP的ID。

HaVipName

String

havip-1

高可用虚拟IP的名称。

  • 长度限制为1 ~ 128个字符。
  • 需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短横线(-)。

Description

String

This is my HaVip.

高可用虚拟IP的描述。

  • 长度限制为0~ 255个字符。
  • 需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。

返回数据

参数名称
类型
示例值
描述
RequestIdStringF3CD6886-D8D0-4FEE-B93E-1B732396****请求ID。

请求示例

GET /?Action=ModifyHaVipAttributes&Version=2020-04-01&HaVipId=havip-2zeo05qre24nhrqp****&Description=This is my HaVip.&HaVipName=havip-1 HTTP/1.1
Host: open.volcengineapi.com  
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "F3CD6886-D8D0-4FEE-B93E-1B732396****",
        "Action": "ModifyHaVipAttributes",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "F3CD6886-D8D0-4FEE-B93E-1B732396****"
    }
}

错误码

此处仅展示当前API的错误码,更多错误码请参见公共错误码

HttpCode
错误码
错误信息
描述
400InvalidHaVip.InvalidStatusThe specified HaVip is not in the correct status for the request.指定的高可用虚拟IP所处状态无法响应该请求。
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
404InvalidHaVip.NotFoundThe specified HaVip does not exist.指定的高可用虚拟IP不存在。