List Projects
Lists all projects in the specified cloud region.
GET
https://controller.${CLOUD_REGION}.zillizcloud.com/v1/projects
Example
📘Notes
This API requires an API key as the authentication token.
export CLOUD_REGION="gcp-us-west1"
export API_KEY=""
curl --location --request GET "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/projects" \
--header "Authorization: Bearer ${API_KEY}"
Possible response is similar to the following.
{
"code": 200,
"data": [
{
"createTimeMilli": 1685006867000,
"instanceCount": 1,
"projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
"projectName": "Default Project"
}
]
}
Request
Parameters
-
No query parameters required
-
No path parameters required
-
Header parameters
Parameter Description Authorization string
Request Body
No request body required
Response
Returns a list of projects.
Response Body
{
"code": "integer",
"data": [
{
"instanceCount": "integer",
"projectId": "string",
"projectName": "string"
}
]
}
Property | Description |
---|---|
code | integer Indicates whether the request succeeds.
|
data | array |
data[] | object |
data[].instanceCount | integer |
data[].projectId | string |
data[].projectName | string |
Error Response
{
"code": integer,
"message": string
}
Property | Description |
---|---|
code | integer Indicates whether the request succeeds.
|
message | string Indicates the possible reason for the reported error. |