修改IPAM地址池基本信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:UpdateIpamPool | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | IPAM 托管地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
IpamPoolId | string | 是 | IPAM 地址池的实例 ID。 | ipam-pool-6rcq3tobayc20t**** |
IpamPoolName | string | 否 | 要修改的 IPAM 地址池的名称。 长度为 1~128 个字符,不能以 | test |
IpamPoolDescription | string | 否 | 要修改的 IPAM 地址池的描述信息。 长度为 1~256 个字符,必须以大小写英文字母或中文字符开头,但不能以 | test description |
AllocationDefaultCidrMask | integer | 否 | 要修改的 IPAM 地址池默认网络掩码。 取值范围:0~32位。 | 28 |
AllocationMaxCidrMask | integer | 否 | 要修改的 IPAM 地址池最大网络掩码。 取值范围:0~32位。 | 32 |
AllocationMinCidrMask | integer | 否 | 要修改的 IPAM 地址池最小网络掩码。 取值范围:0~32位。 | 8 |
ClearAllocationDefaultCidrMask | boolean | 否 | 是否清除 IPAM 地址池默认网络掩码。取值:
| true |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
AutoImport | boolean | 否 | 地址池是否开启自动导入功能。 | true |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "9DED57B9-7654-5B6D-93F7-BCA5839FEE38"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OperationDenied.PoolRegionNotSupportUpdatePool | The operation is not allowed because of pool region not support update. | 操作被拒绝,原因是无法在该地域执行更新地址池操作。 |
400 | IllegalParam.AllocationDefaultNetmask | The specified AllocationDefaultNetmask is illegal. | AllocationDefaultNetmask参数不合法。 |
400 | IllegalParam.AllocationMaxNetmask | The specified AllocationMaxNetmask is illegal. | AllocationMaxNetmask参数不合法。 |
400 | IllegalParam.AllocationMinNetmask | The specified AllocationMinNetmask is illegal. | AllocationMinNetmask参数不合法。 |
400 | IllegalParam.IpVersion | The specified IpVersion is illegal. | IpVersion参数不合法。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun校验通过。 |
400 | OperationDenied.OperateShareResource | The operation is not allowed because the instance is a shared resource. | 该实例是共享资源,不允许操作。 |
404 | ResourceNotFound.IpamPool | The dependent IPAM pool is not found. | 依赖资源IPAM Pool不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |