# Alibaba Cloud VPC IP Address Management API

> Alibaba Cloud VPC IP Address Management API on Apizie: 41 endpoints (Adds members to an IP Address Manager (IPAM), Provisions a CIDR block for an IPAM pool, Associates a resource discovery with an IPAM instance, Changes the resource group of an IPAM resource, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-vpcipam/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-vpcipam`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/vpcipam
- Page: https://apizie.tech/api/cloud/aliyun-vpcipam
- OpenAPI: https://apizie.tech/api/cloud/aliyun-vpcipam/openapi.json

Alibaba Cloud OpenAPI for VPC IP Address Management (vpcipam, version 2023-02-28). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds members to an IP Address Manager (IPAM)
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/add-ipam-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the IPAM hosted region. Call the https://help.aliyun.com/document_detail/36063.html operation to get the region ID |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The request is checked for required parameters, request… |
| ClientToken | string | no | A client token to ensure the idempotence of the request. Generate a unique value from your client for each request. The ClientToken… |
| Members | string | yes | The members managed by the IPAM trusted service (JSON-encoded) |

### Provisions a CIDR block for an IPAM pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/add-ipam-pool-cidr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the IPAM hosted region. You can call https://help.aliyun.com/document_detail/36063.html to obtain the region ID |
| IpamPoolId | string | yes | The instance ID of the IPAM pool |
| Cidr | string | no | The CIDR block to provision. Private top-level pools support provisioning only by specifying a CIDR block |
| NetmaskLength | integer | no | Provisions a CIDR block by specifying a netmask length. Public IPv6 top-level pools support provisioning only by specifying a netmask length |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without provisioning a CIDR block for the IPAM pool. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. A client-generated value that is unique across different requests.… |

### Associates a resource discovery with an IPAM instance
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/associate-ipam-resource-discovery` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| IpamId | string | yes | The ID of the IPAM instance |
| IpamResourceDiscoveryId | string | yes | The ID of the resource discovery instance |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no… |
| ClientToken | string | no | Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. If this… |

### Changes the resource group of an IPAM resource
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the hosted region. Call https://help.aliyun.com/document_detail/36063.html to get the region ID |
| ResourceId | string | yes | The ID of the resource whose resource group you want to change |
| NewResourceGroupId | string | yes | The ID of the new resource group |
| ResourceType | string | yes | The resource type. Valid values: Ipam: an IPAM instance IpamScope: an IPAM scope IpamPool: an IPAM pool IpamResourceDiscovery: an IPAM… |

### Creates an IP Address Manager (IPAM)
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/create-ipam` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the IPAM instance is hosted. You can call the https://help.aliyun.com/document_detail/36063.html operation to… |
| IpamName | string | no | The name of the IPAM. It must be 1 to 128 characters in length and cannot start with `http://` or `https://` |
| OperatingRegionList | string | yes | The effective regions of the IPAM (JSON-encoded) |
| 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://`.… |
| ResourceGroupId | string | no | The resource group ID of the IPAM |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| 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… |
| Tag | string | no | The tag list (JSON-encoded) |

### Create an IPAM address pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/create-ipam-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the IPAM. You can call the https://help.aliyun.com/document_detail/36063.html API to obtain the region ID |
| IpamScopeId | string | yes | The instance ID of the IPAM scope |
| IpamPoolName | string | no | The name of the IPAM address pool. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://` |
| IpamPoolDescription | string | no | The description of the IPAM address pool. The description must be 1 to 256 characters in length and must start with an uppercase or… |
| ResourceGroupId | string | no | The resource group ID of the IPAM address pool |
| PoolRegionId | string | no | The region where the IPAM address pool takes effect |
| SourceIpamPoolId | string | no | The instance ID of the source IPAM address pool. If this parameter is not specified, the created address pool is a parent address pool |
| AllocationDefaultCidrMask | integer | no | The default CIDR mask for allocations from the IPAM address pool. The IPv4 CIDR mask ranges from 0 to 32 bits. The IPv6 CIDR mask ranges… |
| AllocationMaxCidrMask | integer | no | The maximum CIDR mask for allocations from the IPAM address pool. The IPv4 CIDR mask ranges from 0 to 32 bits. The IPv6 CIDR mask ranges… |
| AllocationMinCidrMask | integer | no | The minimum CIDR mask for allocations from the IPAM address pool. The IPv4 CIDR mask ranges from 0 to 32 bits. The IPv6 CIDR mask ranges… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotency of the request. You can use the client to generate the token, but you must make… |
| IpVersion | string | no | The IP address protocol version. Valid values: IPv4: IPv4. IPv6: IPv6 |
| Ipv6Isp | string | no | The type of IPv6 CIDR block. This parameter takes effect only for public IPv6 address pools. Valid values: BGP (default): Alibaba Cloud… |
| AutoImport | string | no | Specifies whether to enable the auto-import feature for the address pool |
| Tag | string | no | The tag list (JSON-encoded) |

### Creates a custom reserved CIDR block from an IPAM pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/create-ipam-pool-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where you want to create the custom reserved CIDR block. You can call… |
| IpamPoolId | string | yes | The ID of the IPAM pool |
| Cidr | string | no | The CIDR block to allocate from the IPAM pool. You must specify either the Cidr or CidrMask parameter |
| CidrMask | integer | no | The mask of the CIDR block to allocate from the IPAM pool. You must specify either the Cidr or CidrMask parameter |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request. The custom reserved CIDR block is not created. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a value on your client to make sure that the value is… |
| IpamPoolAllocationDescription | string | no | The description of the custom reserved CIDR block. The description must be 1 to 256 characters in length. It must start with a letter or a… |
| IpamPoolAllocationName | string | no | The name of the custom reserved CIDR block. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://` |

### Creates a resource discovery instance of a custom type
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/create-ipam-resource-discovery` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The request region. The request region is the hosted region of the resource discovery instance |
| IpamResourceDiscoveryName | string | no | The name of the resource discovery |
| IpamResourceDiscoveryDescription | string | no | The description of the resource discovery |
| OperatingRegionList | string | yes | The list of regions where the resource discovery is effective (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request without creating the resource discovery instance. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a unique parameter value from your client. The client… |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates scopes for IPAM to manage private and public IP addresses
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/create-ipam-scope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the IPAM instance is hosted. Call the https://help.aliyun.com/document_detail/36063.html operation to get the… |
| IpamId | string | yes | The ID of the IPAM instance |
| IpamScopeName | string | no | The name of the IPAM scope. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://` |
| IpamScopeDescription | string | no | The description of the IPAM scope. The description must be 1 to 256 characters in length and must start with a letter. It cannot start… |
| ResourceGroupId | string | no | The ID of the resource group to which the IPAM scope belongs |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request but does not create the IPAM scope. The request is… |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request. Generate a unique value from your client. The token can contain only… |
| IpamScopeType | string | no | The type of the IPAM scope: private. Currently, you can create only private scopes |
| Tag | string | no | The tags (JSON-encoded) |

### Deletes an IPAM instance
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/delete-ipam` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the IPAM instance is deployed. You can call the https://help.aliyun.com/document_detail/36063.html operation to… |
| IpamId | string | yes | The ID of the IPAM instance |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no… |
| ClientToken | string | no | Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. If you do… |

### Deletes an IPAM pool instance
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/delete-ipam-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the IPAM managed region. You can call the https://help.aliyun.com/document_detail/36063.html operation to obtain the… |
| IpamPoolId | string | yes | The instance ID of the IPAM pool |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without actually deleting the IPAM pool instance. The… |
| 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, but you must make… |

### Releases a CIDR allocation from an IP Address Management (IPAM) address pool. Supported allocation types…
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/delete-ipam-pool-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the CIDR block allocation that you want to release is located. You can call the… |
| IpamPoolAllocationId | string | yes | The ID of the CIDR block allocation that you want to release |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format,… |
| ClientToken | string | no | Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. If you do… |

### Deletes a provisioned CIDR block from an IP Address Manager (IPAM) pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/delete-ipam-pool-cidr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the IPAM is hosted. For more information, see https://help.aliyun.com/document_detail/36063.html |
| IpamPoolId | string | yes | The ID of the IPAM pool |
| Cidr | string | yes | The provisioned CIDR block to delete. Only IPv4 CIDR blocks are supported |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no… |
| ClientToken | string | no | Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. If you do… |

### Deletes a resource discovery instance
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/delete-ipam-resource-discovery` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| IpamResourceDiscoveryId | string | yes | The ID of the resource discovery instance |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no… |
| ClientToken | string | no | Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. If you do… |

### Deletes an IPAM scope
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/delete-ipam-scope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the IPAM is hosted. Call the https://help.aliyun.com/document_detail/36063.html operation to get the region ID |
| IpamScopeId | string | yes | The instance ID of the IPAM scope |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks whether the required parameters are… |
| 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… |

### Disassociates a resource discovery from an IP Address Manager (IPAM) instance
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/dissociate-ipam-resource-discovery` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| IpamId | string | yes | The instance ID of the IPAM |
| IpamResourceDiscoveryId | string | yes | The instance ID of the resource discovery |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no… |
| ClientToken | string | no | Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. If you do… |

### Queries a specified CIDR block allocation in an IPAM pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/get-ipam-pool-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region of the IPAM pool to which the CIDR block allocation belongs. If the IPAM pool has a region attribute, this parameter specifies… |
| IpamPoolAllocationId | string | yes | The ID of the IPAM pool allocation |

### Retrieves an available CIDR block from an IPAM pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/get-ipam-pool-next-available-cidr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region of the IPAM pool. If the IPAM pool has a region property, this parameter specifies the region where the pool is active. If the… |
| IpamPoolId | string | yes | The instance ID of the IPAM pool |
| CidrBlock | string | no | The CIDR block to be allocated. You must specify CidrBlock or CidrMask |
| CidrMask | integer | no | The mask length of the CIDR block to be allocated. You must specify CidrBlock or CidrMask |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The… |

### Retrieves the status of the IPAM service
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/get-vpc-ipam-service-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. If you do… |
| RegionId | string | yes | The ID of the managed region of IPAM |

### Lists the IP addresses used by discovered resources in a VPC or vSwitch
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-discovered-ip-addresses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the resource discovery instance is hosted |
| IpamResourceDiscoveryId | string | yes | The ID of the resource discovery instance |
| VpcId | string | no | The ID of a discovered VPC. You must specify at least one of VpcId and VSwitchId |
| VSwitchId | string | no | The ID of a discovered VSwitch. You must specify at least one of VpcId and VSwitchId |
| Cidr | string | no | The CIDR block to search for used IP addresses in a VPC or vSwitch. To query a specific IP address, use a /32 prefix length. Only IPv4… |
| IpVersion | string | no | The IP protocol version. Valid value: IPv4 |
| NextToken | string | no | The token used to retrieve the next page of results. Valid values: Do not specify this parameter for your first request. If a next page… |
| MaxResults | integer | no | The maximum number of entries to return per page. Valid values: 1 to 200. Default value: 100 |

### Queries the information about resources in resource discovery
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-discovered-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The hosted region ID of the resource discovery instance. You can call the https://help.aliyun.com/document_detail/36063.html operation to… |
| IpamResourceDiscoveryId | string | yes | The instance ID of the resource discovery |
| ResourceRegionId | string | yes | The operation region for resource discovery |
| ResourceType | string | no | The resource type. Valid values: VPC: VPC VSwitch: vSwitch |
| NextToken | string | no | The token for the next query. Valid values: You do not need to specify this parameter for the first query or when no subsequent queries… |
| MaxResults | integer | no | The maximum number of entries to return for a single request. Valid values: 1 to 100. Default value: 10 |

### Queries the members managed by the IPAM trusted service
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where IPAM is hosted. You can call the https://help.aliyun.com/document_detail/448570.html operation to query the… |
| MemberIds | string | no | The IDs of the members managed by the IPAM trusted service (JSON-encoded) |
| NextToken | string | no | The token for the next query. Valid values: If NextToken is empty, no subsequent query is available. If NextToken returns a value, the… |
| MaxResults | integer | no | The maximum number of entries to return for a paginated query. Valid values: 1 to 100. Default value: 10 |

### Queries the CIDR allocation information of an IPAM pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-pool-allocations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region of the IPAM pool to which the IPAM pool CIDR allocation belongs. If the IPAM pool to which the IPAM pool CIDR allocation… |
| IpamPoolId | string | yes | The instance ID of the IPAM pool |
| IpamPoolAllocationIds | string | no | The list of instance IDs of the CIDR blocks that you allocate from the IPAM pool (JSON-encoded) |
| Cidr | string | no | The allocated CIDR block used to query the allocation information. Only IPv4 CIDR blocks are supported |
| IpamPoolAllocationName | string | no | The name of the IPAM pool CIDR allocation. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://` |
| NextToken | string | no | The token for the next query. Valid values: If NextToken is empty, no next query is available. If NextToken has a return value, the value… |
| MaxResults | integer | no | The maximum number of entries to return for a paginated query. Valid values: 1 to 100. Default value: 10 |

### Queries the provisioned CIDR blocks of an IPAM pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-pool-cidrs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the IPAM is created. Call the https://help.aliyun.com/document_detail/36063.html operation to obtain the region… |
| IpamPoolId | string | yes | The instance ID of the IPAM pool |
| Cidr | string | no | The provisioned CIDR block to query. Only IPv4 CIDR blocks are supported |
| NextToken | string | no | The token that is used to retrieve the next page of results. Set the value to the `NextToken` value that is returned in the last call. You… |
| MaxResults | integer | no | The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10 |

### Queries the details of IPAM pools
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-pools` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where IPAM is hosted. You can call the https://help.aliyun.com/document_detail/36063.html operation to query the… |
| IpamScopeId | string | no | The instance ID of the IPAM scope |
| IpamPoolIds | string | no | The instance IDs of the IPAM pools. Valid values of N: 1 to 100. You can query up to 100 IPAM pools at a time (JSON-encoded) |
| IpamPoolName | string | no | The name of the IPAM pool. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://` |
| SourceIpamPoolId | string | no | The instance ID of the source IPAM pool |
| PoolRegionId | string | no | The region where the IPAM pool takes effect |
| ResourceGroupId | string | no | The ID of the resource group to which the IPAM pool belongs |
| Tags | string | no | The tags (JSON-encoded) |
| NextToken | string | no | The pagination token for the next query. Valid values: For the first query or when no subsequent query is required, leave this parameter… |
| MaxResults | integer | no | The maximum number of entries to return for a paginated query. Valid values: 1 to 100. Default value: 10 |
| IsShared | string | no | Specifies whether the IPAM pool is shared |
| IpVersion | string | no | The IP version. Valid values: IPv4: IPv4. IPv6: IPv6 |
| Ipv6Isp | string | no | The ISP type of the IPv6 CIDR block. This parameter takes effect only for public IPv6 pools. Valid values: BGP (default): Alibaba Cloud… |

### Queries resources within an IPAM scope
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-resource-cidrs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where IPAM is hosted. You can call the https://help.aliyun.com/document_detail/36063.html operation to query region IDs |
| IpamScopeId | string | no | The instance ID of the IPAM scope |
| IpamPoolId | string | no | Instance ID of the IPAM pool. IpamPoolId cannot be instance ID of a shared pool |
| ResourceId | string | no | The ID of the resource |
| ResourceType | string | no | The type of the resource. Valid values: VPC: VPC. VSwitch: vSwitch |
| NextToken | string | no | The pagination token for the next query. Valid values: Leave this parameter empty for the first query or when no subsequent query is… |
| MaxResults | integer | no | The maximum number of entries to return for a paginated query. Valid values: 1 to 100. Default value: 10 |
| VpcId | string | no | The instance ID of the VPC-connected instance to which the resource belongs |

### Queries IPAM resource discovery instances
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-resource-discoveries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource discovery to query. You can call the https://help.aliyun.com/document_detail/36063.html operation to obtain… |
| ResourceGroupId | string | no | The resource group ID of the resource discovery |
| IpamResourceDiscoveryIds | string | no | The instance IDs of the resource discoveries. Valid values of N: 1 to 100. You can query up to 100 resource discovery instances at a time… |
| IpamResourceDiscoveryName | string | no | The name of the resource discovery. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://` |
| Type | string | no | The type of the resource discovery. Supported types: system: the default resource discovery created by the system. custom: the custom… |
| Tags | string | no | The tags (JSON-encoded) |
| NextToken | string | no | The pagination token for the next query. Valid values: If NextToken is empty, no subsequent query is available. If NextToken returns a… |
| MaxResults | integer | no | The maximum number of entries to return for a single request. Valid values: 1 to 100. Default value: 10 |
| IsShared | string | no | Specifies whether the resource discovery is shared |

### Lists the associations between resource discoveries and IP Address Managers (IPAMs)
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-resource-discovery-associations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| IpamId | string | no | The ID of the IPAM instance |
| IpamResourceDiscoveryId | string | no | The ID of the resource discovery instance |
| NextToken | string | no | The token that is used to retrieve the next page of results. For the first query, leave this parameter empty. For a subsequent query, set… |
| MaxResults | integer | no | The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 10 |

### Queries the details of IPAM scopes
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipam-scopes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the hosted region for IPAM. You can call the https://help.aliyun.com/document_detail/36063.html operation to query the region ID |
| IpamId | string | no | The instance ID of the IPAM |
| IpamScopeType | string | no | The scope type of the IPAM scope. Valid values: public: public scope. private: private scope |
| IpamScopeIds | string | no | The list of instance IDs of IPAM scopes (JSON-encoded) |
| IpamScopeName | string | no | The name of the IPAM scope. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://` |
| ResourceGroupId | string | no | The ID of the resource group to which the IPAM scope belongs |
| Tags | string | no | The list of tags (JSON-encoded) |
| NextToken | string | no | The pagination token for the next query. Valid values: If this is the first query or no subsequent query is required, you do not need to… |
| MaxResults | integer | no | The maximum number of entries to return for a paginated query. Valid values: 1 to 100. Default value: 10 |

### Queries IPAM instances
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-ipams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the hosted region for the IPAM. You can call the https://help.aliyun.com/document_detail/448570.html operation to query region IDs |
| ResourceGroupId | string | no | The ID of the resource group to which the IPAM belongs |
| IpamIds | string | no | The list of IPAM instance IDs. Valid values of N: 1 to 100. You can query up to 100 IPAM instances at a time (JSON-encoded) |
| 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://` |
| Tags | string | no | The list of tags (JSON-encoded) |
| NextToken | string | no | The token for the next query. Valid values: If this is the first query or no next query is to be sent, you do not need to specify this… |
| MaxResults | integer | no | The maximum number of entries to return for a paginated query. Valid values: 1 to 100. Default value: 10 |

### Queries the tags that are associated with resources
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| ResourceId | string | no | The resource IDs (JSON-encoded) |
| ResourceType | string | yes | The resource type. Valid values: IPAM: IPAM IPAMSCOPE: IPAM scope IPAMPOOL: IPAM address pool |
| Tag | string | no | The tags (JSON-encoded) |
| NextToken | string | no | The token that is used for the next query. Valid values: You do not need to specify this parameter for the first query. For a subsequent… |
| MaxResults | integer | no | The number of entries to return on each page. Valid values: 1 to 50. Default value: 10 |

### Activates the IP Address Management (IPAM) service
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/open-vpc-ipam-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. This token is generated by the client and must be unique for each… |
| RegionId | string | yes | The ID of the managed region for IPAM |

### Removes members from the IPAM trusted service
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/remove-ipam-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the IPAM is hosted. To get the region ID, call the https://help.aliyun.com/document_detail/36063.html operation |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the required parameters, the request… |
| ClientToken | string | no | A client token to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among… |
| Members | string | yes | The members managed by the IPAM trusted service (JSON-encoded) |

### Adds a tag to a resource
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| ResourceId | string | yes | The IDs of the resources (JSON-encoded) |
| ResourceType | string | yes | The resource type. Valid values: IPAM IPAMSCOPE IPAMPOOL |
| Tag | string | yes | The tags to add to the resources (JSON-encoded) |

### Removes a tag from a resource
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| ResourceId | string | yes | The resource IDs (JSON-encoded) |
| ResourceType | string | yes | The resource type. Valid values: IPAM IPAMSCOPE IPAMPOOL |
| TagKey | string | no | The keys of the tags that you want to remove from the resource (JSON-encoded) |
| All | string | no | Specifies whether to remove all tags from the specified resource. Valid values: true false (default) |

### Modifies an IP Address Management (IPAM) instance
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/update-ipam` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the hosted region. You can call the https://help.aliyun.com/document_detail/36063.html operation to get the region ID |
| IpamId | string | yes | The instance ID of the IPAM |
| 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… |
| 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… |
| AddOperatingRegion | string | no | The list of operating regions to add to the IPAM (JSON-encoded) |
| RemoveOperatingRegion | string | no | The list of operating regions to remove from the IPAM (JSON-encoded) |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the required parameters, request format,… |
| 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… |

### Updates the basic information of an IPAM pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/update-ipam-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the hosted region of the IPAM. Call https://help.aliyun.com/document_detail/448570.html to get the region ID |
| IpamPoolId | string | yes | The instance ID of the IPAM pool |
| IpamPoolName | string | no | The new name of the IPAM pool. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://` |
| IpamPoolDescription | string | no | The new description of the IPAM pool. The description must be 1 to 256 characters in length. It must start with a letter or a Chinese… |
| AllocationDefaultCidrMask | integer | no | The new default network mask for the IPAM pool. Valid values: 0 to 32 |
| AllocationMaxCidrMask | integer | no | The new maximum network mask for the IPAM pool. Valid values: 0 to 32 |
| AllocationMinCidrMask | integer | no | The new minimum network mask for the IPAM pool. Valid values: 0 to 32 |
| ClearAllocationDefaultCidrMask | string | no | Specifies whether to clear the default network mask of the IPAM pool. Valid values: true: Yes. false: No |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request without modifying the IPAM pool. The system checks for… |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request. Generate a unique token for each request. The token can contain only… |
| AutoImport | string | no | Specifies whether to enable the auto import feature for the address pool |

### Updates a CIDR allocation from an IPAM address pool
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/update-ipam-pool-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the CIDR allocation is located. To obtain a region ID, call the… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Sends a check request without modifying the CIDR allocation. The system checks… |
| ClientToken | string | no | A client token to ensure the idempotence of the request. Generate a unique value from your client for each request. ClientToken supports… |
| IpamPoolAllocationDescription | string | no | The description of the CIDR allocation. The description must be 1 to 256 characters long and must start with a letter or a Chinese… |
| IpamPoolAllocationName | string | no | The name of the CIDR allocation. The name must be 1 to 128 characters long. It cannot start with `http://` or `https://` |
| IpamPoolAllocationId | string | yes | The ID of the CIDR allocation |

### Modifies a resource discovery instance
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/update-ipam-resource-discovery` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| IpamResourceDiscoveryId | string | yes | The ID of the resource discovery instance |
| IpamResourceDiscoveryName | string | no | The name of the resource discovery |
| IpamResourceDiscoveryDescription | string | no | The description of the resource discovery |
| AddOperatingRegion | string | no | The operating regions to add to the resource discovery (JSON-encoded) |
| RemoveOperatingRegion | string | no | The operating regions to remove from the resource discovery (JSON-encoded) |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no… |
| ClientToken | string | no | Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. If you do… |

### Updates the basic information of an IPAM scope
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/update-ipam-scope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the IPAM is hosted. Call the https://help.aliyun.com/document_detail/36063.html operation to get the region ID |
| IpamScopeId | string | yes | The ID of the IPAM scope |
| IpamScopeName | string | no | The name of the IPAM scope. The name must be 1 to 128 characters long and cannot start with `http://` or `https://` |
| IpamScopeDescription | string | no | The description of the IPAM scope. The description must be 1 to 256 characters long. It must start with a letter and cannot start with… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the request for potential issues,… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a value for this parameter that is unique among different… |

### version
`POST https://apizie.tech/v1/cloud:aliyun-vpcipam/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vpcipam.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-vpcipam/add-ipam-members" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud VPC IP Address Management API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-vpcipam/add-ipam-members with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud VPC IP Address Management API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud VPC IP Address Management itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud VPC IP Address Management API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-vpcipam.

### What is the status of the Alibaba Cloud VPC IP Address Management API?
Needs your own provider key (bring your own key)