Platform Center
Home / API Documentation / Project management / Basic operation of project / View project list

*View project list

Requests

HTTP request

GET /auth/v1/projects

List projects, with rbac enabled

Responses

Content-Type application/json

Status code: 200

OK

Sample response

{
   "apiVersion": "auth.alauda.io/v1",
   "items": [
     {
       "apiVersion": "auth.alauda.io/v1",
       "kind": "Project",
       "metadata": {
         "annotations": {
           "cpaas.io/creator": "admin@cpaas.io",
           "cpaas.io/description": "cpaas",
           "cpaas.io/display-name": "cpaas",
           "cpaas.io/unite-quota-fed-clusters": "",
           "cpaas.io/updated-at": "2021-06-28T03:34:24Z"
         },
         "creationTimestamp": "2021-06-28T03:34:24Z",
         "finalizers": [
           "namespace"
         ],
         "generation": 2,
         "labels": {
           "cpaas.io/project": "cpaas",
           "cpaas.io/project.id": "114038197",
           "cpaas.io/project.level": "1",
           "cpaas.io/project.parent": ""
         },
         "name": "cpaas",
         "resourceVersion": "41289584",
         "selfLink": "/apis/auth.alauda.io/v1/projects/cpaas",
         "uid": "9733309c-695e-4ea2-b2a4-8f96fd24ada1"
       },
       "spec": {
         "clusters": [
           {
             "name": "global",
             "quota": {
               "limits.cpu": "5",
               "limits.memory": "5Gi",
               "persistentvolumeclaims": "5",
               "pods": "5",
               "requests.cpu": "5",
               "requests.memory": "5Gi",
               "requests.storage": "5Gi"
             },
             "type": ""
           }
         ]
       },
       "status": {
         "phase": "Active",
         "version": "331f49118708aa89d6804ee90a5321d7"
       }
     }
   ],
   "kind": "ProjectList",
   "metadata": {
     "continue": "",
     "resourceVersion": "41390751",
     "selfLink": "/apis/auth.alauda.io/v1/projects"
   }
 }

Parameters

Name Type Description
apiVersion string See common parameters
items array list of project
Path: items
items[] object
Path: items[]
items[].apiVersion string See common parameters
items[].kind string See common parameters
items[].metadata object See common parameters
items[].spec object
Path: items[].spec
spec.clusters array Clusters contains the clusters associated with this Project
Path: items[].spec.clusters
spec.clusters[] object
Path: items[].spec.clusters[]
clusters[].name string name of cluster
Path: items[].spec.clusters[].name
clusters[].quota object quota info of cluster within project
Path: items[].spec.clusters[].quota
clusters[].type string type of cluster
Path: items[].spec.clusters[].type
items[].status object
Path: items[].status
status.phase string Phase record the state of project
Path: items[].status.phase
kind string See common parameters
metadata object See common parameters

Other status codes