UpdateIpam - 修改IPAM实例_专有网络VPC(VPC)-阿里云帮助中心

修改IPAM实例。

接口说明

为 IPAM 实例移除生效地域时，不能包含 IPAM 托管地域。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:UpdateIpam

update

*Ipam

acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	IPAM 托管地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
IpamId	string	是	IPAM 的实例 ID。	ipam-ccxbnsbhew0d6t****
IpamName	string	否	IPAM 的名称。长度为 1～128 个字符，不能以`http://`或`https://`开头。	test
IpamDescription	string	否	IPAM 的描述信息。长度为 1～256 个字符，必须以英文大小写字母或中文开头。但不能以`http://`或`https://`开头。默认为空，不填则为空。	test description
AddOperatingRegion	array	否	为 IPAM 添加的生效地域列表。
	string	否	为 IPAM 添加的生效地域。	eu-central-1
RemoveOperatingRegion	array	否	为 IPAM 移除的生效地域列表。
	string	否	为 IPAM 移除的生效地域。	cn-beijing
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会修改 IPAM 实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码 DryRunOperation。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并修改 IPAM 实例。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000

返回参数

名称	类型	描述	示例值
	object	返回的信息列表。
RequestId	string	请求 ID。	F4650E33-895C-53F0-9CD5-D1338F322DE8

示例

正常返回示例

JSON格式

{
  "RequestId": "F4650E33-895C-53F0-9CD5-D1338F322DE8"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.	输入的IPAM不存在。
400	IllegalParam.OperatingRegion	The operating region is invalid.	生效地域非法。
400	DependencyViolation.IpamPool	The specified resource of %s depends on %s, so the operation cannot be completed.	指定的资源被其他的资源依赖，不允许进行当前操作。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun校验通过。
400	OperationDenied.IpamRegionCannotBeRemoved	The IPAM region cannot be removed.	不能移除IPAM托管地域。

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

变更历史

更多信息，参考变更详情。