DeleteIpamScope - Virtual Private Cloud - Alibaba Cloud Documentation Center

Deletes an IPAM scope.

Operation description

Usage notes

You cannot delete the two default IPAM scopes that the system automatically creates.
Before you delete a custom IPAM scope, ensure that all IPAM pools in the scope are deleted. You can call the DeleteIpamPool operation to delete 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:DeleteIpamScope

delete

*IpamScope

acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPAM is hosted. Call the DescribeRegions operation to get the region ID.	cn-hangzhou
IpamScopeId	string	Yes	The instance ID of the IPAM scope.	ipam-scope-glfmcyldpm8lsy****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks whether the required parameters are specified, the request format is valid, and the service limits are met. 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, an HTTP 2xx status code is returned and the IPAM scope is deleted.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a value for this parameter on your client to make sure that the value is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is different.	88144bdb-b190-4813-a3f5-66cc86694162

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	9F8315CB-560E-5F1E-B069-6E44B440CAF8

Examples

Success response

JSON format

{
  "RequestId": "9F8315CB-560E-5F1E-B069-6E44B440CAF8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.IpamScope	The specified resource of IPAM scope is not found.	The input IPAM scope does not exist.
400	IncorrectStatus.IpamScope	The status of the IPAM scope is incorrect.	The status of the IPAM scope is incorrect.
400	OperationDenied.DeleteDefaultScope	The operation is not allowed because of deleting default scope.	The operation was denied because the default IPAM scope was deleted.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.