Integration Guides › Web Service API Reference Guide › Valid Web API Objects › vol Object › repair_status Method (vol Object)

repair_status Method (vol Object)

Description

Retrieve list of current volume repair status

Syntax

/api/v1/vol/repair_status?app=application&vol=volume&vdc=controller-name 

Arguments

app

Name of the application

vol

Name of the volume

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve list of repair status for test:vol1.

GET http://192.168.123.200/api/v1/vol/repair_status?app=test&vol=vol1&vdc=mygrid 

Sample Output

XML:

<message>
Name : test:vol
Comment : 
UUID : cf432100-63fc-450d-8eb7-2da6deca8627 
Size : 1.00 GB 
State : ok 
Filesystem : ext3 
Mount State : available 
Mounted Device : none 
Current Users : 0 
Time Created : Fri Apr 23 12:47:11 2010 
Time Written : Fri Apr 23 12:47:12 2010 
Time Accessed : Fri Apr 23 13:11:50 2010 
Number Mirrors : 1 
Mirrors : 
   Server State
   srv1   ok 
</message> 

JSON:

{ } 

HTTP Error Codes

404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

400.1

The specified volume 'test:data' does not exist. - Invalid application or volume specified in the request.

clean Method (vol Object)

Description

Destroy unused volume(s), unused volume streams, and volumes that have broken symbolic links

Syntax

/api/v1/vol/clean?vdc=controller-name 

Arguments

vdc

Name of the target virtual data center

Transaction Type

asynchronous

Request Type

GET

Examples

Destroy unused volume(s), unused volume streams, and volumes that have broken symbolic links.

GET http://192.168.123.200/api/v1/vol/clean?vdc=mygrid 

Sample Output

XML:

<job>be805915-76b2-48c8-b8a0-b881cca66da6</job> 

JSON:

{
   "job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
} 

HTTP Error Codes

404

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.