Skip to main content

List Projects

Lists all projects in the specified cloud region.


GET
https://{cluster-endpoint}/v1/projects

Example

Notes
  • This API requires an API Key as the authentication token.
curl --request GET \
--url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/projects" \
--header "Authorization: Bearer ${API_KEY}" \
--header "accept: application/json" \
--header "content-type: application/json"

Success response:

{
"code": 200,
"data": [
{
"instanceCount": 1,
"projectId": "proj-********************",
"projectName": "test"
}
]
}

Request

Parameters

  • No query parameters required

  • No path parameters required

Request Body

No request body required

Response

Returns a list of projects.

Response Bodies

  • Response body if we process your request successfully
{
"code": "integer",
"data": [
{
"instanceCount": "integer",
"projectId": "string",
"projectName": "string"
}
]
}
  • Response body if we failed to process your request
{
"code": integer,
"message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
dataarray
data[]object
data[].instanceCountinteger
Number of clusters in the current project.
data[].projectIdstring
ID of the current project
data[].projectNamestring
Name of the current project
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
(to be added)