全部产品
Search
文档中心

专有网络 VPC:ModifyHaVipAttribute - 修改HaVip实例的名称和描述

更新时间:Nov 13, 2024

调用ModifyHaVipAttribute接口修改HaVip实例的名称和描述。

接口说明

ModifyHaVipAttribute 不支持并发修改同一个 HaVip 实例的名称和描述。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:ModifyHaVipAttributeupdate
  • HaVip
    acs:vpc:{#regionId}:{#accountId}:havip/{#HaVipId}

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-0016e0****
RegionIdstring

HaVip 实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
HaVipIdstring

要修改的 HaVip 实例 ID。

havip-2zeo05qre24nhrqp****
Descriptionstring

HaVip 实例的描述。

描述长度为 1~256 个字符,不能以http://https://开头。

This is my HaVip.
Namestring

HaVip 实例的名称。

名称长度为 1~128 个字符,不能以http://https://开头。

test

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

C44F62BE-9CE7-4277-B117-69243F3988BF

示例

正常返回示例

JSON格式

{
  "RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectStatusHaVip can be deleted only when it's status is Available or InUse.-
400InvalidDescription.MalformedThe specified Description is wrongly formed.入参Description无效
400Abs.Vpc.InvalidName.MalformedThe specified Name is not valid.传入的Name无效
400Forbidden.HaVipNo permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.操作HaVip没有权限,请到配额中心申请权限。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。
404InvalidHaVipId.NotFoundThe specified HaVip does not exist in the specified region.指定的HaVip不在指定的地域中,请您检查选择的地域是否正确。

访问错误中心查看更多错误码。