Zones
Contributors
Download PDF of this page
Use the methods listed in the following table to create, modify, and delete zones. For APIs that allow you to retrieve zones, see the (Consumer) Administration APIs.
HTTP Method | Path | Description |
---|---|---|
|
|
Create a new zone. |
|
|
Modify the details of a zone. |
|
|
Delete a zone. |
Zone attributes
The following table lists the zone attributes.
Attribute | Type | Description |
---|---|---|
|
String |
the unique identifier of the zone. |
|
String |
The zone name. |
|
String |
The description of the zone. |
|
String |
The name of the region in which the zone resides. |
Retrieve all zones
Use the method listed in the following table to retrieve all zones or a subset of zones. Specifying a region will return only the block stores belonging to that tenant.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Retrieve zones. |
(Optional) Region name (string) |
Required request body attributes: none
Request body example:
none
Response body example:
{ "status": { "user_message": "Okay. Returned 1 record.", "verbose_message": "", "code": 200 }, "result": { "returned_records": 1, "total_records": 5, "sort_by": "created", "order_by": "desc", "offset": 2, "limit": 1, "records": [ { "id": "5ce5d919b68d3b82dc34bef2", "name": "au-west1-a", "description": "au-west1-a", "region": "au-west1" } ] }
Retrieve a zone by name
Use the method listed in the following table to retrieve a zone by the zone name.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Retrieve a zone by name. |
|
Required request body attributes: none
Request body example:
none
Response body example:
{ "status": { "user_message": "Okay. Returned 1 record.", "verbose_message": "", "code": 200 }, "result": { "returned_records": 1, "records": [ { "id": "5ce5d919b68d3b82dc34bef2", "name": "au-west1-a", "description": "au-west1-a", "region": "au-west1" } ] } }
Create a zone
Use the method listed in the following table to create a zone.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Create a new zone within a region. |
None |
Required request body attributes: name
, description
, region_name
Request body example:
{ "name": "MyZoneName", "description": "DescriptionOfMyZone", "region_name": "MyRegionName" }
Response body example:
{ "status": { "user_message": "Okay. New resource created.", "verbose_message": "", "code": 201 }, "result": { "total_records": 1, "records": [ { "id": "5e61741c9b64790001fe9663", "name": "MyZoneName", "description": "DescriptionOfMyZone", "region": "MyRegionName" } ] } }
Modify a zone
Use the method listed in the following table to modify a zone.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Modify a zone identified by name. |
|
Required request body attributes: none
Request body example:
{ "name": "MyZoneName", "description": "NewDescriptionOfMyZone" }
Response body example:
{ "status": { "user_message": "Okay. Returned 1 record.", "verbose_message": "", "code": 200 }, "result": { "total_records": 1, "records": [ { "id": "5e61741c9b64790001fe9663", "name": "MyZoneName", "description": "NewDescriptionOfMyZone", "region": "MyRegionName" } ] } }
Delete a zone
Use the method listed in the following table to delete a zone.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Delete a single zone identified by name. All storage resources within a zone must be deleted first. |
|
Required request body attributes: none
Request body example:
none
Response body example:
No content to return on a successful deletion.