List Cloud VM Sets
Request
Method |
URI |
---|---|
GET |
v5/cvmsets/ |
Privileges Required
Any valid KeyControl user account can list all Cloud VM Sets that are owned by groups in which the requesting user is a member.
Note: A user account cannot access the Cloud VM Sets that belong to a group unless the user account is also a part of that group. This applies even to privileged accounts such as secroot
or other accounts with CLOUD_ADMIN privileges.
Parameters
None.
Response
Name |
Type |
Example |
---|---|---|
cvmsets |
list |
|
cvmsets[i].description |
string |
AWS VMs for engineering |
cvmsets[i].geofencing |
integer |
0 Whether the BoundaryControl Feature is enabled for this Cloud VM Set. |
cvmsets[i].group |
string |
Cloud Admin Group |
cvmsets[i].groupid |
string |
21172d4493f911e3b4ed080027cbdf2a |
cvmsets[i].id |
string |
78a7e865947a11e3b4ed080027cbdf2a |
cvmsets[i].name |
string |
Amazon AWS VMs |
cvmsets[i].num_registered_vms | integer |
20 |
cvmsets[i].uri |
string |
/v5/cvmsets/78a7e865947a11e3b4ed080027cbdf2a/ |
result |
string |
success |
Errors
Reason |
Example |
---|---|
Invalid token. |
Invalid or expired session; please login |