CreateIpam - Virtual Private Cloud - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Creates an IP Address Manager (IPAM).

Operation description

You can create only one IPAM with each Alibaba Cloud account in each region.
Only IPv4 IP addresses can be allocated.
When you create an IPAM instance:
- If there is no custom resource discovery in the region, the system creates a default resource discovery associated with the IPAM instance.
- If there is a custom resource discovery in the region, the system converts it to a default resource discovery and associates it with the IPAM instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:CreateIpam	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPAM instance is hosted. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
IpamName	string	No	The name of the IPAM. It must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	abc
OperatingRegionList	array	Yes	The effective regions of the IPAM.
OperatingRegionList	string	Yes	The effective region of the IPAM. Note You can select one or more regions.	cn-hangzhou
IpamDescription	string	No	The description of the IPAM. It must be 1 to 256 characters in length. Start with a letter but cannot start with `http://` or `https://`. If you do not specify a description, the description is empty by default.	This is my first Ipam
ResourceGroupId	string	No	The resource group ID of the IPAM.	rg-acfmxazb4ph6aiy****
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, 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): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
ClientToken	string	No	The client token used to ensure the idempotence of the request. Use the client to generate the token, but you must make sure that the token is unique among different requests. The client 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 may be different for each request.	123e4567-e89b-12d3-a456-426655440000
Tag	array<object>	No	The tag list.
Tag	object	No	The tag list.
Key	string	No	The tag key of the resource. You can specify at most 20 tag keys. It cannot be an empty string. The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter but cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. You can specify empty strings as tag values. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED39DCAC0
IpamId	string	The ID of the IPAM.	ipam-ccxbnsbhew0d6t****
PrivateDefaultScopeId	string	The default private scope created by the system after the IPAM is created.	ipam-scope-8wiontzmiy6cg0****
PublicDefaultScopeId	string	The default public scope created by the system after the IPAM is created.	ipam-scope-r5c5c7bmym1brc****
DefaultResourceDiscoveryId	string	The ID of the default resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****
DefaultResourceDiscoveryAssociationId	string	The ID of the default resource discovery association.	ipam-res-disco-assoc-jt5fac8twugdbbgip****
ResourceDiscoveryAssociationCount	integer	The number of discovered resources.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED39DCAC0",
  "IpamId": "ipam-ccxbnsbhew0d6t****",
  "PrivateDefaultScopeId": "ipam-scope-8wiontzmiy6cg0****",
  "PublicDefaultScopeId": "ipam-scope-r5c5c7bmym1brc****",
  "DefaultResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
  "DefaultResourceDiscoveryAssociationId": "ipam-res-disco-assoc-jt5fac8twugdbbgip****",
  "ResourceDiscoveryAssociationCount": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	UnsupportedRegion.Ipam	Ipam is not supported in this region.	IPAM is not supported in this region.
400	QuotaExceeded.IpamQuotaPerRegion	The quota of ipamQuotaPerRegion count is exceeded.	The maximum number allowed by IPAM exceeds the limit.
400	IllegalParam.OperatingRegion	The operating region is invalid.	The operating region is invalid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	-
400	OperationFailed.OperatingRegionsNeedIncludeIpamRegion	The operating regions do not contain IPAM region.	The operating regions do not contain IPAM region.
400	UnsupportedFeature.Ipam	IPAM is not supported in this region.	The IPAM feature is not supported in this region.
400	OptInRequired.Ipam	You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.	You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-12	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-08-28	The Error code has changed. The response structure of the API has changed	View Change Details