1.1. Colocation Space¶
List Colocation Space¶
List all visible Colocation Spaces.
Synchronous / Asynchronous¶
- Synchronous 
Request¶
HTTP Request Method¶
- GET 
HTTP Request Path¶
{endpoint}/v2.0/colocation_spaces
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Description | Required | 
|---|---|---|---|---|---|---|
| description | query | string | - | - | Colocation Space description | no | 
| id | query | string | hyph-uuid | - | Colocation Space unique id | no | 
| name | query | string | - | - | Colocation Space name | no | 
| plane | query | string | - | ['data'] | Connection type (only data) | no | 
Response¶
HTTP Response Code List¶
| Response Code | Description | 
|---|---|
| 200 | OK | 
| 400 | Bad Request | 
| 401 | UnAuthorized | 
| 404 | Not Found | 
| 500 | Internal Server Error | 
HTTP Response Parameters¶
| Parameter | Type | Format | Description | 
|---|---|---|---|
| colocation_spaces | array<object> | datatype_colocation_space | - | 
| description | string | - | Colocation Space description | 
| id | string | hyph-uuid | Colocation Space unique id | 
| name | string | - | Colocation Space name | 
| plane | string | - | Connection type (only data) | 
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
  "colocation_spaces": [
    {
      "description": "Lab1 10G colo TEST",
      "id": "b33afaf9-f371-4f34-909c-b8822e3b87e1",
      "name": "Tokyo No.1 Data Center",
      "plane": "data"
    },
    {
      "description": "Lab1 1G colo TEST",
      "id": "312caada-99da-440a-a8d8-c3fd0f9d0194",
      "name": "Tokyo No.2 Data Center",
      "plane": "storage"
    }
  ]
}
Show Colocation Space¶
Show details for Colocation Space.
Synchronous / Asynchronous¶
- Synchronous 
Request¶
HTTP Request Method¶
- GET 
HTTP Request Path¶
{endpoint}/v2.0/colocation_spaces/{colocation_space_id}
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Description | Required | 
|---|---|---|---|---|---|---|
| colocation_space_id | URI | string | hyph-uuid | - | Colocation Space unique id | yes | 
Response¶
HTTP Response Code List¶
| Response Code | Description | 
|---|---|
| 200 | OK | 
| 400 | Bad Request | 
| 401 | UnAuthorized | 
| 404 | Not Found | 
| 500 | Internal Server Error | 
HTTP Response Parameters¶
| Parameter | Type | Format | Description | 
|---|---|---|---|
| colocation_space | object | datatype_colocation_space | - | 
| description | string | - | Colocation Space description | 
| id | string | hyph-uuid | Colocation Space unique id | 
| name | string | - | Colocation Space name | 
| plane | string | - | Connection type (only data) |