API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (VpcIpam/2023-02-28) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
IPAM
|
API |
Title |
Description |
| OpenVpcIpamService | OpenVpcIpamService | Activates the IP Address Management (IPAM) service. |
| GetVpcIpamServiceStatus | GetVpcIpamServiceStatus | Retrieves the status of the IPAM service. |
| DeleteIpam | DeleteIpam | Deletes an IPAM instance. |
| UpdateIpam | UpdateIpam | Modifies an IP Address Management (IPAM) instance. |
| ListIpams | ListIpams | Queries one or more IPAMs. |
IPAM pool
|
API |
Title |
Description |
| CreateIpamPool | CreateIpamPool | Creates an IPAM address pool. |
| DeleteIpamPool | DeleteIpamPool | Deletes an IPAM address pool. |
| UpdateIpamPool | UpdateIpamPool | Updates the basic information of an IPAM pool. |
| ListIpamPools | ListIpamPools | Queries information about IPAM pools. |
| AddIpamPoolCidr | AddIpamPoolCidr | Provisions a CIDR block for an IPAM pool. |
| DeleteIpamPoolCidr | DeleteIpamPoolCidr | Deletes a provisioned CIDR block from an IP Address Manager (IPAM) pool. |
| ListIpamPoolCidrs | ListIpamPoolCidrs | Queries the provisioned CIDR blocks of an IPAM pool. |
| CreateIpamPoolAllocation | CreateIpamPoolAllocation | Creates a custom reserved CIDR block from an IPAM pool. |
| DeleteIpamPoolAllocation | DeleteIpamPoolAllocation | Releases a CIDR allocation from an IP Address Management (IPAM) address pool. Supported allocation types include virtual private cloud (VPC) and custom allocation. |
| UpdateIpamPoolAllocation | UpdateIpamPoolAllocation | Updates a CIDR allocation from an IPAM address pool. |
| GetIpamPoolAllocation | GetIpamPoolAllocation | Queries the details of a CIDR block allocation in a specified IPAM pool. |
| ListIpamPoolAllocations | ListIpamPoolAllocations | Queries information about CIDR block allocations in an IPAM pool. |
| GetIpamPoolNextAvailableCidr | GetIpamPoolNextAvailableCidr | Retrieves an available CIDR block from an IPAM pool. |
Resource discovery
|
API |
Title |
Description |
| CreateIpamResourceDiscovery | CreateIpamResourceDiscovery | Creates a resource discovery instance of a custom type. |
| DeleteIpamResourceDiscovery | DeleteIpamResourceDiscovery | Deletes a resource discovery instance. |
| UpdateIpamResourceDiscovery | UpdateIpamResourceDiscovery | Modifies a resource discovery instance. |
| ListIpamResourceDiscoveries | ListIpamResourceDiscoveries | Retrieves a list of IPAM resource discovery instances. |
| AssociateIpamResourceDiscovery | AssociateIpamResourceDiscovery | Associates a resource discovery with an IPAM instance. |
| DissociateIpamResourceDiscovery | DissociateIpamResourceDiscovery | Disassociates a resource discovery from an IP Address Manager (IPAM) instance. |
| ListIpamResourceDiscoveryAssociations | ListIpamResourceDiscoveryAssociations | Lists the associations between resource discoveries and IP Address Managers (IPAMs). |
| ListIpamDiscoveredResource | ListIpamDiscoveredResource | Queries discovered resources. |
Resource group
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of an IPAM resource. |
Tag
|
API |
Title |
Description |
| ListTagResources | ListTagResources | Queries the tags that are associated with resources. |
Others
|
API |
Title |
Description |
| CreateIpam | CreateIpam | Creates an IP Address Manager (IPAM). |
| CreateIpamScope | CreateIpamScope | Creates scopes for IPAM to manage private and public IP addresses. |
| DeleteIpamScope | DeleteIpamScope | Deletes an IPAM scope. |
| ListIpamMembers | ListIpamMembers | Lists the members managed by the IPAM trusted service. |
| ListIpamResourceCidrs | ListIpamResourceCidrs | Lists the CIDR blocks of resources in an IPAM scope. |
| ListIpamScopes | ListIpamScopes | Queries the details of IPAM scopes. |
| TagResources | TagResources | Adds a tag to a resource. |
| UntagResources | UntagResources | Removes a tag from a resource. |
| UpdateIpamScope | UpdateIpamScope | Updates the basic information of an IPAM scope. |