Display the grid ACL, or display that portion of the grid ACL which relates to a particular principal.
/api/v1/vdc/get_acl?vdc=controller-name
Name of the target virtual data center
synchronous
GET
Example: Display ACL for vdc mygrid
GET http://192.168.123.200/api/v1/vdc/get_acl?vdc=mygrid
{
"acl" : {
"owner" : {
"id" : "a5cb10bc-7291-4a86-84f8-74419fc9ae63"
},
"entries" : {
"entries[0]" : {
"app_developer" : 1,
"id" : "4f865f5b-e63a-410a-9d9a-96427c3ecfc7"
},
"entries[2]" : {
"grid_administrator" : 1,
"id" : "a5cb10bc-7291-4a86-84f8-74419fc9ae63"
},
"entries[1]" : {
"app_developer" : 1,
"id" : "e1a5357f-204b-4cd3-9ca8-9e09f45b21c6"
}
}
}
}
<acl>
<entries>
<name>entries[0]</name>
<app_developer>1</app_developer>
<id>4f865f5b-e63a-410a-9d9a-96427c3ecfc7</id>
</entries>
<entries>
<name>entries[1]</name>
<app_developer>1</app_developer>
<id>e1a5357f-204b-4cd3-9ca8-9e09f45b21c6</id>
</entries>
<entries>
<name>entries[2]</name>
<grid_administrator>1</grid_administrator>
<id>a5cb10bc-7291-4a86-84f8-74419fc9ae63</id>
</entries>
<owner>
<id>a5cb10bc-7291-4a86-84f8-74419fc9ae63</id>
</owner>
</acl>
Example: Display the ACL data for principal local:user:api@3tera.com for vdc mygrid
GET http://192.168.123.200/api/v1/vdc/get_acl?principal=local%3Auser%3Aapi%403tera.com&vdc=mygrid
{
"acl" : {
"entries" : {
"entries[0]" : {
"app_developer" : 1,
"id" : "4f865f5b-e63a-410a-9d9a-96427c3ecfc7"
}
}
}
}
<acl>
<entries>
<name>entries[0]</name>
<app_developer>1</app_developer>
<id>4f865f5b-e63a-410a-9d9a-96427c3ecfc7</id>
</entries>
</acl>
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Entity not found - Failed to retrieve application ACL - ACL does not contain principal local user 'test@3tera.com'.
- An invalid principal was specified
This API is available with WS_API_r6-1.0.6-1 and above.
Replace the entire grid ACL.
/api/v1/vdc/put_acl?owner=<owner>&acl=<ACLs>&vdc=controller-name
A URL-encoded owner attribute of the grid ACL to the specified principal
URL-encoded list of principals separated with a slash (/)
Name of the target virtual data center
synchronous
GET
Replace the entire ACL for vdc mygrid with an owner api@3tera.com
GET http://192.168.123.200/api/v1/vdc/put_acl? owner=local%3Auser%3Aapi%403tera.com&acl=&vdc=mygrid
Replace the entire ACL for vdc mygrid with an owner api@3tera.com and principal local:user:api@3tera.com=app_developer
GET http://192.168.123.200/api/v1/vdc/put_acl?owner=local%3Auser%3Aapi%403tera.com&acl=local%3Auser%3Aapi%403tera.com%3Dapp_developer&vdc=mygrid
Replace the entire ACL for vdc mygrid with an owner api@3tera.com and principal local:user:api@3tera.com=app_developer/local:user:test@3tera.com=monitor.
GET http://192.168.123.200/api/v1/vdc/put_acl?owner=local%3Auser%3Aapi%403tera.com&acl=local%3Auser%3Aapi%403tera.com%3Dapp_developer%2Flocal%3Auser%3Atest%403tera.com%3Dmonitor&vdc=mygrid
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (owner)
- Argument owner=owner
Missing required arguments (acl)
- Argument acl=acl missing
Entity not found - Failed to put grid ACL - invalid principal data - principal local user 'test@3tera.com' does not exist.
- An invalid owner or acl was specified
{
"message" : ""
}
<message></message>
This API is available with WS_API_r6-1.0.6-1 and above.
Replace that portion of the grid ACL which relates to the owner or a principal.
/api/v1/vdc/modify_acl?acl=<ACLs>&vdc=controller-name
URL-encoded list of principals separated with a slash (/)
Name of the target virtual data center
synchronous
GET
Replace that portion of the grid ACL which relates to the local user 'api@3tera.com', providing grid_administrator access level permissions to this user
GET http://192.168.123.200/api/v1/vdc/modify_acl?acl=local%3Auser%3Aapi%403tera.com%3Dgrid_administrator&vdc=mygrid
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (acl)
- Argument acl=acl missing
Entity not found - Failed to modify ACL - invalid principal data - principal local user 'test@3tera.com' does not exist.
- An invalid acl was specified
{
"message" : ""
}
<message></message>
This API is available with WS_API_r6-1.0.6-1 and above.
Reboot a grid
/api/v1/vdc/reboot?&vdc=controller-name
Name of the target virtual data center
Reason why the grid is being rebooted.
asynchronous
GET
Reboot grid mygrid.
GET http://aux/api/v1/vdc/reboot?&vdc=mygrid&reason=maintenance
<job>be805915-76b2-48c8-b8a0-b881cca66d10</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66d10"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Shut a grid down
/api/v1/vdc/shutdown?&vdc=controller-name
Name of the virtual data center to shutdown
Reason why the grid is being shutdown.
asynchronous
GET
Shut the grid mygrid down.
GET http://aux/api/v1/vdc/shutdown?&vdc=mygrid&reason=maintenance
<job>be805915-76b2-48c8-b8a0-b881cca66d11</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66d11"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Power cycle a grid
/api/v1/vdc/power_cycle?&vdc=controller-name
Name of the target virtual data center
asynchronous
GET
Power cycle the grid mygrid
GET http://192.168.123.200/api/v1/vdc/power_cycle?vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66d12</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66d12"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Only valid when "Power Control" is enabled.
|
Copyright © 2012 CA.
All rights reserved.
|
|