UpdateIpamPool - Virtual Private Cloud - Alibaba Cloud Documentation Center

Updates the basic information of an IPAM pool.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:UpdateIpamPool

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the hosted region of the IPAM. Call DescribeRegions to get the region ID.	cn-hangzhou
IpamPoolId	string	Yes	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
IpamPoolName	string	No	The new name of the IPAM pool. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	test
IpamPoolDescription	string	No	The new description of the IPAM pool. The description must be 1 to 256 characters in length. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. If you do not specify this parameter, the value is not changed. By default, the value is empty.	test description
AllocationDefaultCidrMask	integer	No	The new default network mask for the IPAM pool. Valid values: 0 to 32.	28
AllocationMaxCidrMask	integer	No	The new maximum network mask for the IPAM pool. Valid values: 0 to 32.	32
AllocationMinCidrMask	integer	No	The new minimum network mask for the IPAM pool. Valid values: 0 to 32.	8
ClearAllocationDefaultCidrMask	boolean	No	Specifies whether to clear the default network mask of the IPAM pool. Valid values: true: Yes. false: No.	true
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a check request without modifying the IPAM pool. The system checks for required parameters, request format, and service limits. If the check fails, an error message is returned. If the check succeeds, the `DryRunOperation` error code is returned. false (default): Sends a normal request. After the request passes the check, a 2xx HTTP status code is returned and the IPAM pool is modified.	false
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. Generate a unique token for each request. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID of each API request is different.	123e4567-e89b-12d3-a456-426655440000
AutoImport	boolean	No	Specifies whether to enable the auto import feature for the address pool.	true

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	9DED57B9-7654-5B6D-93F7-BCA5839FEE38

Examples

Success response

JSON format

{
  "RequestId": "9DED57B9-7654-5B6D-93F7-BCA5839FEE38"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.PoolRegionNotSupportUpdatePool	The operation is not allowed because of pool region not support update.	The operation was denied because the update address pool operation could not be performed in the domain
400	IllegalParam.AllocationDefaultNetmask	The specified AllocationDefaultNetmask is illegal.	AllocationDefaultNetmask parameter is illegal.
400	IllegalParam.AllocationMaxNetmask	The specified AllocationMaxNetmask is illegal.	AllocationMaxNetmask parameter is illegal.
400	IllegalParam.AllocationMinNetmask	The specified AllocationMinNetmask is illegal.	AllocationMinNetmask parameter is illegal.
400	IllegalParam.IpVersion	The specified IpVersion is illegal.	Invalid IpVersion.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	OperationDenied.OperateShareResource	The operation is not allowed because the instance is a shared resource.	The operation is not allowed because the instance is a shared resource.
404	ResourceNotFound.IpamPool	The dependent IPAM pool is not found.	The IPAM pool does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.