# Alibaba Cloud Vector Retrieval Service for Milvus API

> Alibaba Cloud Vector Retrieval Service for Milvus API on Apizie: 21 endpoints (Changes the resource group of a resource, Creates an ACL group, Creates the service role required by Milvus to access other cloud products, Creates a cluster instance, …) 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://www.apizie.tech/v1/cloud:aliyun-milvus/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Vector Retrieval Service for Milvus (milvus, version 2023-10-12). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Changes the resource group of a resource
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| NewResourceGroupId | string | yes | The new resource group ID |
| RegionId | string | no | The region ID |
| ResourceType | string | no | The resource type |
| ResourceId | string | no | The resource ID |
| ResourceGroupId | string | no | The resource group ID |

### Creates an ACL group
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/create-acl-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| instanceId | string | no | The instance ID |
| regionId | string | no | The region ID |
| groupName | string | no | The name of the ACL group |
| cidrs | string | no | Specify one or more CIDR blocks, separated by commas |

### Creates the service role required by Milvus to access other cloud products
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/create-default-role` (byok)

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

### Creates a cluster instance
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| aiFunction | string | no | Specifies whether to enable the AI function |
| autoBackup | string | no | Specifies whether to enable automatic backup |
| autoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: Enables automatic payment. false: Generates an order without payment.… |
| autoRenew | string | no | Specifies whether to enable auto-renewal. This parameter takes effect only when the billing method of the instance is Subscription |
| backupRestoreInfo | object | no | The backup and restoration information |
| components | array | no | The component information |
| configuration | string | no | The configuration items |
| dbAdminPassword | string | no | The database password |
| dbVersion | string | yes | The Milvus version |
| encrypted | string | no | Specifies whether to enable OSS encryption |
| ha | string | no | Specifies whether to enable high availability (HA) |
| instanceName | string | no | The instance name |
| isMultiAzStorage | string | no | Specifies whether to enable multi-zone storage |
| kmsKeyId | string | no | The ID of the Key Management Service (KMS) key used for encryption |
| loadReplicas | integer | no | The number of loaded replicas |
| multiZoneMode | string | no | The zone configuration |
| nodeType | string | no | The Query node type |
| paymentDuration | integer | no | The subscription duration |
| paymentDurationUnit | string | no | The unit of the subscription duration |
| paymentType | string | yes | The billing method |
| promotionNo | string | no | The coupon code |
| resourceGroupId | string | no | The resource group ID |
| tags | array | no | The instance tags |
| vSwitchIds | array | no | The vSwitches |
| vpcId | string | yes | The VPC ID |
| zoneId | string | yes | The primary zone |
| clientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Get the public IP address whitelist of a Milvus instance
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/describe-access-control-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the instance |

### Retrieves the custom configuration information of each Milvus component
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/describe-instance-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieves the details of an instance
`GET https://www.apizie.tech/v1/cloud:aliyun-milvus/get-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceId | string | yes | The instance ID |

### Retrieves the details of a single instance
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/get-instance-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |

### Retrieves the group information and content for the current user
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/list-acl-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| instanceId | string | no | The cluster ID |
| regionId | string | no | The region ID |

### Queries the Milvus instances under the current account
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| ClusterName | string | no | The instance name |
| ClusterId | string | no | The instance ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| RegionId | string | no | The region ID |
| ResourceGroupId | string | no | The resource group ID |
| Tag | string | no | The tag information (JSON-encoded) |

### Searches for clusters by cluster ID or name
`GET https://www.apizie.tech/v1/cloud:aliyun-milvus/list-instances-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| instanceName | string | no | The cluster name |
| instanceId | string | no | The cluster ID |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The page size |
| resourceGroupId | string | no | The resource group ID |
| tag | string | no | The list of tags in JSON format (JSON-encoded) |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| nextToken | string | no | The pagination token for the next request (not currently enabled) |

### Updates the configuration parameters of Milvus components
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/modify-instance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Reason | string | yes | The reason for the update |
| UserConfig | string | no | The custom configuration |
| body | string | no | Submits the instance configurations to be updated as a JSON object (JSON-encoded) |

### Adds tags to resources
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ResourceId | array | yes | The IDs of the resources. You can specify up to 50 resource IDs |
| ResourceType | string | yes | The resource type |
| Tag | array | yes | The tags to add to the resources. You can add up to 20 tags |

### Remove resource tags
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/un-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ResourceType | string | yes | The resource type |
| ResourceId | string | yes | The resource IDs. A maximum of 50 resource IDs are supported (JSON-encoded) |
| TagKey | string | no | The tag keys to remove. A maximum of 20 tag keys are supported (JSON-encoded) |
| All | string | no | Specifies whether to remove all tags from the resources. This parameter takes effect only when the TagKey parameter is left empty. Valid… |

### Sets the IP address whitelist for public access to a Milvus instance
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/update-access-control-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| Cidr | string | no | The CIDR block |
| AclId | string | no | The public access control ID |

### Modifies the whitelist in a group
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/update-acl-group-cidrs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| groupName | string | no | The name of the whitelist group |
| instanceId | string | no | The instance ID |
| newCidrs | string | no | The CIDR blocks |

### Updates an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/update-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| autoBackup | string | no | Specifies whether to enable automatic backup |
| autoPay | string | no | Specifies whether automatic payment is used for the order |
| components | array | no | The component information |
| configuration | string | no | The configuration information |
| ha | string | no | Specifies whether to enable high availability |
| instanceId | string | yes | The instance ID |
| instanceName | string | no | The instance name |
| 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 ensure… |

### Changes the name of an instance
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/update-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| ClusterName | string | yes | The name of the instance |
| InstanceId | string | yes | The ID of the instance |

### Enables or disables public network access for a Milvus cluster
`POST https://www.apizie.tech/v1/cloud:aliyun-milvus/update-public-network-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://milvus.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ComponentType | string | yes | The component type. Valid values: Proxy |
| PublicNetworkEnabled | string | yes | Specifies whether public network access is enabled |
| Cidr | string | no | The CIDR block |

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

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

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-milvus/change-resource-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Vector Retrieval Service for Milvus API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-milvus/change-resource-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Vector Retrieval Service for Milvus API?
Yes. Add the Apizie MCP server (https://www.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-milvus.

### What is the status of the Alibaba Cloud Vector Retrieval Service for Milvus API?
Needs your own provider key (bring your own key)