REST API - get

vcenter datacenter: get

Retrieves information about the datacenter corresponding to datacenter.

Request:

HTTP request

GET https://{server}/rest/vcenter/datacenter/{datacenter}

Path Parameters

Name Type Description
Required
datacenter string Identifier of the datacenter.

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "datastore_folder""obj-103",
        "host_folder""obj-103",
        "network_folder""obj-103",
        "name""string",
        "vm_folder""obj-103"
    }
}

Response Type:

Name Type Description
bold = required
value info Information about the datacenter associated with datacenter.
value.name string The name of the datacenter.

value.datastore_folder string The root datastore folder associated with the datacenter.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.

value.host_folder string The root host and cluster folder associated with the datacenter.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.

value.network_folder string The root network folder associated with the datacenter.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.

value.vm_folder string The root virtual machine folder associated with the datacenter.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
404 not_found if there is no datacenter associated with datacenter in the system.
503 service_unavailable if the system is unable to communicate with a service to complete the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.