Browse Vcenter Compute Item

Browse Vcenter Compute Item

Browse files and folders accessible to vCenter server's compute object.

Request
URI
GET
https://{api_host}/pairings/{pairing_id}/vcenters/{vcenter_id}/inventory/compute/{compute_id}/browser
COPY
Path Parameters
string
pairing_id
Required

The ID of a pairing between this Site Recovery Manager server and remote one.

string
vcenter_id
Required

The ID of a vCenter server.

string
compute_id
Required

The ID of a vCenter Server's compute object.Supported types:

  • ClusterComputeResource
  • ComputeResource
  • HostSystem
  • ResourcePool

Query Parameters
string
path
Optional

The path on the given datastore to browse. Leave empty for root node. Use '/vmimages' when browsing a host without datastore id passed as query param.

string
file_type
Optional

Filter result items by file type.

Possible values are : VM_DISK, FLOPPY_IMAGE, ISO_IMAGE, VM_CONFIG_FILES, ALL_FILES, FOLDERS,
string
datastore_id
Optional

Id of the datastore which you must browse.. Leave empty when browsing hosts and in addition add '/vmimages' as value for path query param.

boolean
sub_folders
Optional

Whether the datastore file system search should include the sub folders of the specified browse path.


Authentication
This operation uses the following authentication methods.
Responses
200

Browse information about vCenter server's compute object.

Returns EnvironmentBrowserDataDrResponseList of type(s) application/json
{
    "list": [
        {
            "name": "string",
            "path": "/datastore-name/testFolder/childFolder",
            "owner": "root",
            "size": 0,
            "modification": 0,
            "type": "string",
            "datastore_name": "string",
            "datastore_id": "string"
        }
    ],
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ],
        "total": 0,
        "offset": 0,
        "limit": 0,
        "links": {
            "next": {
                "href": "string"
            },
            "self": {
                "href": "string"
            },
            "previous": {
                "href": "string"
            }
        }
    }
}
list
Optional

list

_meta
Optional

_meta


400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.