GET /vCloud/orgConfigs/{ID}
Returns a resource representation of a VMware Cloud Director organization configuration with the specified ID.
Request
To get a resource representation of the VMware Cloud Director organization configuration, send the GET HTTP request to the URL of the /vCloud/orgConfigs/{ID} resource:
HTTP Request
GET https://<Enterprise-Manager>:9398/api/vCloud/orgConfigs/{ID} |
or
GET https://<Enterprise-Manager>:9398/api/vCloud/orgConfigs/{ID}?format=Entity |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, the REST API returns an entity or an entity reference of the /vCloud/orgConfigs/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the VMware Cloud Director organization configuration resource, for example: urn:veeam:BackupFile:0874ab95-10e5-4f25-84df-2782ad81f3e5. |
Name | String | Name of the VMware Cloud Director organization configuration resource, for example: org1. |
BackupServerUid | UidType | UID of the backup server parent to the VMware Cloud Director organization configuration resource. |
RepositoryUid | UidType | UID of the backup repository on which the storage quota for the VMware Cloud Director organization is created, for example: urn:veeam:Repository:82db96c3-445c-4a7e-9587-f2d523e839f4. |
QuotaGb | Long | Size of the storage quota assigned to the VMware Cloud Director organization (in GB). |
IsDisabled | Boolean | Defines if the default VMware Cloud Director organization configuration is in the disabled or enabled state. Possible values:
|
JobSettings | — | Job settings used for the organization configuration. For details, see Job Settings. |
UsedQuotaMb | Long | Amount of space on the storage quota consumed by the VMware Cloud Director organization (in MB). |
HostUid | UidType | UID of the VMware Cloud Director host where the VMware Cloud Director organization has been created. |
RepositoryFriendlyName | String | Backup repository name displayed to VMware Cloud Director organization members, for example: Backup Repository 1. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=VCloudOrganizationConfig.
The JobSettings element contains the following job settings.
Element | Type | Description |
|---|---|---|
DefaultSettings | Boolean | Defines if the default VMware Cloud Director organization configuration is in the disabled or enabled state. Possible values:
|
JobSchedulerType | String | Job scheduling options. Possible values:
|
HighPriorityJob | Boolean | Defines whether the backup job has a high priority. Possible values:
|
TemplateJobUid | UidType | UID of the VMware Cloud Director backup job that will be used as a template for VMware Cloud Director organization VMs processing. The backup job must be created in advance on the backup server connected to Veeam Backup Enterprise Manager. Settings of the specified job will be applied to backup jobs created by tenant-side users. If the job UID is not specified, tenant-side jobs will be configured with the default VMware Cloud Director backup job settings. Job settings applied to backup jobs for the VMware Cloud Director organization will be listed in the representation of the /vCloud/orgConfigs/{ID}/backupJobSettings resource. |
Links
Reference | Relationship | Description |
|---|---|---|
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server that contains the VMware Cloud Director server in its infrastructure. |
/vCloud/orgConfigs/{ID} | Alternate | Alternate URL of the /vCloud/orgConfigs/{ID} resource. |
/vCloud/orgConfigs/{ID} | Edit | URL for the PUT /vCloud/orgConfigs/{ID} request. |
/vCloud/orgConfigs/{ID} | Delete | URL for the DELETE /vCloud/orgConfigs/{ID} request. |
/vCloud/orgConfigs/{ID}/backupJobSettings | Down | URL of the /vCloud/orgConfigs/{ID}/backupJobSettings resource — job settings applied to backup jobs for the VMware Cloud Director organization. |
Example
The example below returns an entity representation of the configuration with ID ee1018b4-6f52-489e-80b7-8005e0b2d640.
Request: GET https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <VCloudOrganizationConfig xmlns="http://www.veeam.com/ent/v1.0" Type="VCloudOrganizationConfig" Href="https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?format=Entity" Name="org1" UID="urn:veeam:VCloudOrganizationConfig:ee1018b4-6f52-489e-80b7-8005e0b2d640"> |