This API has a deprecated equivalent from v7.0U1.
Get Datacenter
Retrieves information about the datacenter corresponding to datacenter.
Request
URLURL
https://{api_host}/api/vcenter/datacenter/{datacenter}
Path Parameters
Path Parameters
string
datacenter
Required
Identifier of the datacenter. The parameter must be an identifier for the resource type: Datacenter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
DatacenterInfo of type application/json
Information about the datacenter associated with datacenter.
{
"datastore_folder": "string",
"host_folder": "string",
"name": "string",
"network_folder": "string",
"vm_folder": "string"
}
string
datastore_folder
Required
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.
string
host_folder
Required
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.
string
name
Required
The name of the datacenter.
string
network_folder
Required
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.
string
vm_folder
Required
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.
Code Samples
PowerCLI Client SDK Example
Invoke-GetDatacenter -Datacenter "MyDatacenter"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/datacenter/{datacenter}
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if there is no datacenter associated with datacenter in the system.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/datacenter/{datacenter}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
