Note: This method has been deprecated and is included here for compatibility with existing user scripts. New users should use the config command with the option flag &boundary.
Retrieve application boundary
/api/v1/app/config_boundary?app=application&vdc=controller-name
Name of the application
Name of the target virtual data center
synchronous
GET
Retrieve boundary for application test.
GET http://192.168.123.200/api/v1/app/config_boundary?app=test&vdc=mygrid
<boundary> <name>main</name> <property dns1> <mandatory>1</mandatory> <type>string</type> </property dns1> <property dns2> <dflt></dflt> <type>string</type> </property dns2> . . . <resource bw> <dflt>1000K</dflt> <max>2G</max> <min>1000K</min> </resource bw> . . </boundary>
{
"property dns1" : {
"type" : "string",
"mandatory" : 1
},
"property hostname" : {
"type" : "string",
"mandatory" : 1
},
.
.
.
"resource mem" : {
"min" : "128M",
"max" : "32G",
"dflt" : "256M"
},
.
.
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (app). - Argument app=app missing in the request.
Entity not found – Permission denied – application ‘test’ does not exist.
Start an application
/api/v1/app/start?app=application&vdc=controller-name
Name of the application to be started
Name of the target virtual data center
See Application Control in the Command Line Shell Reference for descriptions of the options available for this command.
asynchronous
GET
Start an application named test.
GET http://192.168.123.200/api/v1/app/start?app=test&vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (app). - Argument app=app missing in the request.
Note: To get the status of job, issue a /api/v1/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Stop an application
/api/v1/app/stop?app=application&vdc=controller-name
Name of the application to be stopped
Name of the target virtual data center
asynchronous
GET
Stop an application named test.
GET http://192.168.123.200/api/v1/app/stop?app=test&vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (app). - Argument app=app missing in the request.
Note: To get the status of job, issue a /api/v1/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Note: This method has been deprecated and is included here for compatibility with existing user scripts. New users should use the stop command with the option flag &all.
Stop all applications
/api/v1/app/stop_all?vdc=controller-name
Name of the target virtual data center
asynchronous
GET
Stop all applications.
GET http://192.168.123.200/api/v1/app/stop_all?vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Note: To get the status of job, issue a /api/v1/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Copy an application
/api/v1/app/copy?app=application&new_name=new-application&vdc=controller-name
Name of the application to be copied
Name of the new application
Name of the target virtual data center
asynchronous
GET
Copy an application named test to test2.
GET http://192.168.123.200/api/v1/app/copy?app=test&new_name=test2&vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (app). - Argument app=app missing in the request.
Missing required arguments (new_name). - Argument new=new-name missing in the request.
Note: To get the status of job, issue a /api/v1/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Restart an application
/api/v1/app/restart?app=application&vdc=controller-name
Name of the application to be restarted
Name of the target virtual data center
asynchronous
GET
Restart an application named test.
GET http://192.168.123.200/api/v1/app/restart?app=test&vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (app). - Argument app=app missing in the request.
Note: To get the status of job, issue a /api/v1/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Migrate an application from a remote grid
/api/v1/app/migrate?grid=remote-grid&app=application&vdc=controller-name
Controller IP or FQDN of a remote grid
Name of the application to be migrated
Name of the target virtual data center
See Application Control in the Command Line Shell Reference for descriptions of the options available for this command.
Note: The migrate method does not support SSH agent forwarding.
asynchronous
GET
Migrate an application named test from remote-grid.mygrid.net.
GET http://192.168.123.200/api/v1/app/migrate?grid=remote-grid.mygrid.net&app=test&vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (app). - Argument app=app missing in the request.
Missing required arguments (grid). - Argument grid=remote-grid missing in the request.
Note: To get the status of job, issue a /api/v1/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
|
Copyright © 2012 CA.
All rights reserved.
|
|