Skip to main content
Version: User Guides (BYOC)

Manage Projects

In Zilliz Cloud, a project serves as a logical container within an organization, grouping clusters, volumes, and related resources. All resources within a project share the same cloud provider and region.

You can create multiple projects tailored to different aspects of your business. For example, if your company offers multimedia recommendation services, you can create one project for video recommendations and another for music recommendations.

In BYOC deployments, each project maps to a single Kubernetes cluster in one region. Cross-region operations are not supported. To operate in multiple regions, create separate BYOC projects.

This guide will walk you through the steps of managing projects.

View all projects​

You can view the list of all projects in your permission scope in the organization.

  • Via RESTful API

    The following example shows how to list all projects in the current organization. For details, see List Projects.

    export TOKEN="YOUR_API_KEY"

    curl --request GET \
    --url "${BASE_URL}/v2/projects" \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json"

    The following is an example output.

    {
      "code": 0,
      "data": [
        {
          "projectName": "project1",
          "projectId": "proj-a0195d6acacaf2bb985173",
          "instanceCount": 3,
          "createTime": "2023-12-07T03:21:32Z",
          "plan": "Standard",
          "projectType": "Regional",
          "regions": ["aws-us-west-2"]
        },
        {
          "projectName": "Default Project",
          "projectId": "proj-412e874430bfa02e857247",
          "instanceCount": 0,
          "createTime": "2023-08-16T07:34:06Z",
          "plan": "Enterprise",
          "projectType": "Legacy",
          "regions": []
        }
      ]
    }

  • Via web console

    view-projects-byoc

View project details​

You can also check the details of a certain project.

  • Via RESTful API

    The following example describes the project proj-xxxxxxxxxxxxxxx. For details, see Describe Project.

    export TOKEN="YOUR_API_KEY"
    export projectId="proj-xx"

    curl --request GET \
    --url "${BASE_URL}/v2/projects/${projectId}" \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "Content-Type: application/json"

    The following is an example output

    {
      "code": 0,
      "data": [
        {
          "projectName": "project1",
          "projectId": "proj-a0195d6acacaf2bb985173",
          "instanceCount": 3,
          "createTime": "2023-12-07T03:21:32Z",
          "plan": "Standard",
          "projectType": "Regional",
          "regions": ["aws-us-west-2"]
        }
      ]
    }

  • Via web console

    You can check the project name, plan, creation time, and the number of clusters within the project on the Projects page. You can further click on a certain project to view its clusters.

    KgjvbAvUkopKWsxnGXycOZEynZd

Rename a project​

To rename a project, you must be an Organization Owner. You can rename a project via the web console.

rename-project-byoc

Delete a project​

To delete a project, you must be an Organization Owner.

Before you delete a project, you must drop all clusters within the project.

Once a project is deleted, all its associated data and resources will be irreversibly cleaned as well.

📘Notes

The default project cannot be deleted.

You can delete a project via the web console.

delete-project-byoc