DeleteIpam-Virtual Private Cloud(VPC)-阿里云帮助中心

Operation description

Before you begin

Before deleting an IPAM instance, ensure that all IPAM pools under the IPAM instance are deleted. You can call the DeleteIpamPool operation to delete IPAM pools.
Before deleting an IPAM instance, ensure that all newly created IPAM scopes under the IPAM instance are deleted. You can call the DeleteIpamScope operation to delete IPAM scopes.
Before deleting an IPAM instance, ensure that the default resource discovery instance under the IPAM instance is not shared.
Before deleting an IPAM instance, ensure that no shared resource discovery instances are associated with the IPAM instance.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the hosted region for the IPAM instance. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou
IpamId	string	Yes	The instance ID of the IPAM.	ipam-ccxbnsbhew0d6t****
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: prechecks the request without deleting the IPAM instance. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the request fails the precheck, the corresponding error is returned. If the request passes the precheck, the DryRunOperation error code is returned. false (default): sends the request. If the request passes the precheck, the HTTP 2xx status code is returned and the IPAM instance is deleted.	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 value, and ensure that the value is unique across different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the client token. The RequestId of each API request is different.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The list of returned information.
RequestId	string	The request ID.	30A20EE2-6223-5D0F-BF49-D7C78F206063

Examples

Success response

JSON format

{
  "RequestId": "30A20EE2-6223-5D0F-BF49-D7C78F206063"
}

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	OperationFailed.IpamScopeExist	The operation is failed because user IPAM scope exist.	The operation failed because a user-defined scope exists.
400	OperationFailed.IpamPoolExist	The operation is failed because user IPAM pool exist.	The operation failed because IPAM has a user-created address pool.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	The DryRun validation passed.
400	OperationDenied.SharedResourceDiscoveryAssociated	The operation is not allowed because the IPAM is associated with a shared resource discovery.	The operation is not allowed because the IPAM is associated with a shared resource discovery.
400	DependencyViolation.ShareResource	The operation is not allowed because the default resource discovery of this IPAM is sharing.	The operation is not allowed because the default resource discovery of this IPAM is sharing.
400	DependencyViolation.IpamMembers	The IPAM [%s] has managed members [%s], so the IPAM cannot be deleted.	IPAM[%s] has managed member [%s], this IPAM cannot be deleted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.