Cloud Management API 1.5
Datacenters
Datacenters represent isolated facilities within a cloud. The level and type of isolation is cloud dependent. While Datacenters in large public clouds might correspond to different physical buildings, with different power, internet links...etc., Datacenters within the context of a private cloud might simply correspond to having different network providers.
Spreading servers across distinct Datacenters helps minimize outages.
Actions
index
Lists all Datacenters for a particular cloud.
- URLs
- GET /api/clouds/:cloud_id/datacenters
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.datacenter;type=collection
Required roles
- observer||instance
Parameters
name | required | type | values | regexp | blank? | description |
---|---|---|---|---|---|---|
filter | no | Array | * | * | no | See below for valid filter parameters. |
view | no | String | default | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Filters
name | partial_match? | description |
---|---|---|
name | yes | Name of the Datacenter / Zone to filter on. |
resource_uid | no | Resource Unique IDentifier for the Datacenter / Zone to filter on. |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"resource_uid": "RESOURCE_795868542",
"name": "NAME_3287855577",
"description": null,
"links": [
{"rel":"self","href":"/api/clouds/888/datacenters/ABC143062639DEF"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"actions": [
]
},{
"resource_uid": "RESOURCE_3374459097",
"name": "NAME_3609709106",
"description": null,
"links": [
{"rel":"self","href":"/api/clouds/888/datacenters/ABC542832548DEF"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"actions": [
]
}]
<?xml version="1.0" encoding="UTF-8"?>
<datacenters>
<datacenter>
<resource_uid>RESOURCE_795868542</resource_uid>
<name>NAME_3287855577</name>
<description/>
<links>
<link rel="self" href="/api/clouds/888/datacenters/ABC143062639DEF"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<actions/>
</datacenter>
<datacenter>
<resource_uid>RESOURCE_3374459097</resource_uid>
<name>NAME_3609709106</name>
<description/>
<links>
<link rel="self" href="/api/clouds/888/datacenters/ABC542832548DEF"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<actions/>
</datacenter>
</datacenters>
show
Displays information about a single Datacenter.
- URLs
- GET /api/clouds/:cloud_id/datacenters/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.datacenter
Required roles
- observer||instance
Parameters
name | required | type | values | regexp | blank? | description |
---|---|---|---|---|---|---|
view | no | String | default | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Example Responses
Click on a format below to see an example response:
JSON XML{
"resource_uid": "RESOURCE_795868542",
"name": "NAME_3287855577",
"description": null,
"links": [
{"rel":"self","href":"/api/clouds/888/datacenters/ABC143062639DEF"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"actions": [
]
}
<?xml version="1.0" encoding="UTF-8"?>
<datacenter>
<resource_uid>RESOURCE_795868542</resource_uid>
<name>NAME_3287855577</name>
<description/>
<links>
<link rel="self" href="/api/clouds/888/datacenters/ABC143062639DEF"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<actions/>
</datacenter>