Virtual data center REST API

Get all virtual data centers

Returns a list of all virtual data centers.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Response body

[
	-{
	-"colocation_policy": "Availability",
	-"compute_nodes": [
	-"/admin/resources/compute_nodes/39c04e23-59ef-493e-a23a-85a8b6374824",
	-"/admin/resources/compute_nodes/99bb903d-7588-46b9-b099-ae553bf8f31b"],
	-"created_time": "Wed 18 Dec 2013 17:42:03.549 UTC",
	-"created_time_raw": 1387388523549,
	-"description": "Default Cloud Pak System Shared Cloud Group",
	-"dr_storage_last_state_change_time": null,
	-"dr_storage_message": null,
	-"dr_storage_progress": null,
	-"dr_storage_state": null,
	-"hypervisor_type": "Platform System_PowerVM",
	-"id": "/admin/resources/vdcs/f9ee31d2-aba2-4e36-9a6f-447bd2943bc4",
	-"ip": "fd8c:215d:178e:1234:290:fa71:fa34:9fd6",
	-"is_highly_available": "T",
	-"is_public": "F",
	-"isas_rn": 1,
	-"label_key": "pure0538",
	-"label_text": "Default Cloud Pak System Shared Cloud Group",
	-"last_state_change_reason_key": null,
	-"last_state_change_reason_text": null,
	-"management_nodes": [ ],
	-"max_memory": 230400,
	-"max_vcpucount": 64,
	-"message": "",
	-"name": "Shared",
	-"state": "available",
	-"storage_volumes": [
	-"/admin/resources/storage_volumes/13690161-8f84-49c1-9c82-50a8e94cd15a",
	-"/admin/resources/storage_volumes/e4abc8fd-c47e-45e4-994c-4a0a0644c866",
	-"/admin/resources/storage_volumes/76b5c18b-8b1f-4377-83ad-bd1f9ee957aa"],
	-"type": "Average",
	-"updated_time": "Thu 09 Jan 2014 15:36:09.186 UTC",
	-"updated_time_raw": 1389281769186,
	-"vdc_stats": [
	-"/admin/resources/vdc_stats/aa80719c-b7ff-4ec0-a393-0e6a0e9d8696"],
	}
	]

compute_nodes

The compute nodes in the virtual data center.

created_time

The time at which the object is created.

created_time_raw

The created_time in long value.

description

A description of the cloud group.

hypervisor_type

The hypervisor type.

id

The unique ID of the object in the system, including the URI, for example:

/admin/resources/vdcs/f9ee31d2-aba2-4e36-9a6f-447bd2943bc4

ip

The IP address for this object.

is_highly_available

Whether it is highly available or not.

is_public

Indicates if the cloud group is used for multi-cloud deployment using external management connectivity. Allowed values include T or F.

isas_rn

An integer value that indicates the relative order of the subcomponent in the table (for example, the 4th subcomponent listed has a value of 4 in this attribute).

label_key

Key for retrieving label for the virtual data center.

label_text

Default translated message text.

last_state_change_reason_key

The reason for the last change in the state of the VDC.

last_state_change_reason_text

Any messages that are associated with state of the VDC are displayed in this area.

management_nodes

The management nodes in the virtual data center.

max_memory

The maximum amount of memory in the virtual data center.

max_vcpucount

The maximum number of virtual CPUs in the data center.

name

The name assigned to the storage virtual data center.

state

The general availability of the object. If pending, the object has been created but not activated. If available, the object is active in the system.

storage_volumes

Storage volumes associated with this VDC.

type

The type of data contained in the object, vdc_stats.

vcpuratio

The CPU ratio used for this virtual data center.

updated_time

A timestamp indicating the date and time when this object was updated. The value is a date and time expressed in Coordinated Universal Time (UTC) format (example: Fri 03 Jan 2014 15:59:20.613 UTC).

updated_time_raw

A machine-readable time stamp indicating when this object was last updated. The value is a long integer (example: 1392069799633).

vdc_stats

The ID of the VDC stats.

Get a specific virtual data center

Returns a single virtual data center identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.