UpdateIpam - Virtual Private Cloud - Alibaba Cloud Documentation Center

Modifies an IP Address Management (IPAM) instance.

Operation description

The managed region of an IPAM instance cannot be removed.

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:UpdateIpam

update

*Ipam

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the hosted region. You can call the DescribeRegions operation to get the region ID.	cn-hangzhou
IpamId	string	Yes	The instance ID of the IPAM.	ipam-ccxbnsbhew0d6t****
IpamName	string	No	The name of the IPAM. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`. The value must be 1 to 128 characters long and cannot start with `http://` or `https://`.	test
IpamDescription	string	No	The description of the IPAM. The description must be 1 to 256 characters in length and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. If you do not specify this parameter, the description is empty. It must be 1 to 256 characters in length and start with a letter or a Chinese character, but cannot start with `http://` or `https://`. The default value is empty.	test description
AddOperatingRegion	array	No	The list of operating regions to add to the IPAM.
	string	No	The operating region to add to the IPAM.	eu-central-1
RemoveOperatingRegion	array	No	The list of operating regions to remove from the IPAM.
	string	No	The operating region to remove from the IPAM.	cn-beijing
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the required parameters, request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned. false (default): Sends the request. If the request passes the check, a 2xx HTTP status code is returned and the IPAM instance is modified.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. ClientToken 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 for each request is unique.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	F4650E33-895C-53F0-9CD5-D1338F322DE8

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.	The IPAM entered does not exist.
400	IllegalParam.OperatingRegion	The operating region is invalid.	The operating region is invalid.
400	DependencyViolation.IpamPool	The specified resource of %s depends on %s, so the operation cannot be completed.	The specified resource is dependent on other resources and the current operation is not allowed.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	OperationDenied.IpamRegionCannotBeRemoved	The IPAM region cannot be removed.	The IPAM region cannot be removed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.