Project

General

Profile

Documentation #5597

/api/v1/cluster/{1}/space needs docs

Added by Yan-Fa Li over 10 years ago. Updated over 10 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
-
Target version:
% Done:

0%

Tags:
Backport:
Reviewed:
Affected Versions:

Description

Can we update the docs to reflect the new API please?
Also what's the difference between cluster and id?

History

#1 Updated by Noah Watkins over 10 years ago

  • Status changed from New to In Progress

#2 Updated by Noah Watkins over 10 years ago

Updated documentation:

https://github.com/inktankstorage/calamari/blob/master/doc/calamari-api.md

Let me know if that works for now (I realize the other APIs need their post/del/etc.. updated).

To answer this `Also what's the difference between cluster and id?`, do you mean a URL like /cluster/{id}/space/? If so, the answer is that {id} is for selecting the the particular cluster we are querying.

#3 Updated by Noah Watkins over 10 years ago

  • Status changed from In Progress to Resolved

#4 Updated by Yan-Fa Li over 10 years ago

No more question was about the output

{
"added_date": "2013-07-11T20:34:02.475Z",
"cluster": 1,
"id": 2718,
"total_avail": 4881196276,
"total_space": 4881423040,
"total_used": 226764
}

What does that 'id' represent?

#5 Updated by Yan-Fa Li over 10 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF