Update A single availability zone

Update a single availability zone

Update an availability zone.

There are different fields for availability zones per IaaS. Look at the examples to see the valid fields for each IaaS.

iaas_configuration_guid is optional if you only have a single IaaS configuration. Multiple IaaS configurations are only supported on vSphere at this time.

Availability zones cannot be updated on Azure.

Availability zones that are already on a deployed product cannot be updated.

Request

URI

PUT

https://{opsmanager-installation}/api/v0/staged/director/availability_zones/{az_guid}

COPY

Path Parameters

string

az_guid

Required

az_guid

Request Body

PutAvailabilityZone of type(s) application/json

Required

Show optional properties

{
    "availability_zone": {
        "name": "string"
    }
}

{
    "availability_zone": {
        "guid": "string",
        "name": "string",
        "iaas_identifier": "string",
        "iaas_configuration_guid": "string",
        "clusters": [
            {
                "guid": "string",
                "cluster": "string",
                "resource_pool": "string",
                "host_group": "string",
                "drs_rule": "string"
            }
        ]
    }
}

availability_zone

Required

availability_zone

Responses

200

Returns ResponseAvailabilityZone of type(s) application/json

{
    "availability_zone": {
        "name": "string",
        "guid": "string",
        "iaas_configuration_guid": "string",
        "iaas_identifier": "string",
        "clusters": [
            {
                "guid": "string",
                "cluster": "string",
                "resource_pool": "string",
                "host_group": "string",
                "drs_rule": "string"
            }
        ]
    }
}

availability_zone

Required

availability_zone

207

Multi-Status. The action succeeded and data was persisted, but errors were returned from verifiers. The configuration may not work when deployed.

Returns ResponseAvailabilityZoneWithWarnings of type(s) application/json

This response body class contains all of the following: InlineResponseAvailabilityZoneWithWarnings0 , AvailabilityZoneVerifierErrors

{
    "availability_zone": {
        "name": "string",
        "guid": "string",
        "iaas_configuration_guid": "string",
        "iaas_identifier": "string",
        "clusters": [
            {
                "guid": "string",
                "cluster": "string",
                "resource_pool": "string",
                "host_group": "string",
                "drs_rule": "string"
            }
        ]
    },
    "verifier_errors": [
        "string"
    ],
    "verifications": {
        "warnings": {
            "warnings": [
                "string"
            ]
        }
    }
}

400

Setup is not completed

Returns RequireSetupCompleted of type(s) application/json

{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

object

errors

Optional

errors

401

Unauthorized

Returns UnauthorizedResponse of type(s) application/json

{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

object

errors

Optional

errors

403

Forbidden

Returns ForbiddenResponse of type(s) application/json

{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

object

errors

Optional

errors

404

Not Found

Returns CommonErrors of type(s) application/json

{
    "errors": [
        "string"
    ]
}

array of string

errors

Required

errors

405

Modifying availability zones is not supported for this IaaS

Returns ModifyingAvailabilityZonesNotSupported of type(s) application/json

{
    "errors": [
        "string"
    ]
}

array of string

errors

Required

errors

422

Unprocessable Content

{
    "errors": [
        "string"
    ]
}

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"availability_zone":"{}"}' https://{api_host}/api/v0/staged/director/availability_zones/{az_guid}

On This Page

Description

Request

Path Parameters

Request Body

Response

200 Response Body

207 Response Body

Errors

Availability Zones Operations

DELETE

Delete A single availability zone