@itentialopensource/adapter-onap_aai

swagger: "2.0" info: description: | [Differences versus the previous schema version](apidocs/aai_swagger_v16.diff) Copyright © 2017-18 AT&T Intellectual Property. All rights reserved. Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License. You may obtain a copy of the License at (https://creativecommons.org/licenses/by/4.0/) Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions. version: "v16" title: Active and Available Inventory REST API license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html contact: name: url: email: host: basePath: /aai/v16 schemes: - https paths: /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string example: __AVAILABILITY-ZONE-NAME__ - name: body in: body description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) required: true schema: $ref: "#/definitions/relationship-dict" delete: tags: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string example: __AVAILABILITY-ZONE-NAME__ /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}: get: tags: - CloudInfrastructure summary: returns ctag-pool description: returns ctag-pool operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool produces: - application/json - application/xml responses: "200": description: successful operation schema: $ref: "#/getDefinitions/ctag-pool" "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string example: __AVAILABILITY-ZONE-NAME__ put: tags: - CloudInfrastructure summary: create or update an existing ctag-pool description: | Create or update an existing ctag-pool. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string example: __AVAILABILITY-ZONE-NAME__ - name: body in: body description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) required: true schema: $ref: "#/definitions/ctag-pool" patch: tags: - CloudInfrastructure summary: update an existing ctag-pool description: | Update an existing ctag-pool # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool consumes: - application/json produces: - application/json responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string example: __AVAILABILITY-ZONE-NAME__ - name: body in: body description: ctag-pool object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/ctag-pool" delete: tags: - CloudInfrastructure summary: delete an existing ctag-pool description: delete an existing ctag-pool operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string example: __AVAILABILITY-ZONE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools: get: tags: - CloudInfrastructure summary: returns ctag-pools description: returns ctag-pools operationId: getCloudInfrastructureComplexesComplexCtagPools produces: - application/json - application/xml responses: "200": description: successful operation schema: $ref: "#/getDefinitions/ctag-pools" "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: availability-zone-name in: query description: required: false type: string /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: body in: body description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json) required: true schema: $ref: "#/definitions/relationship-dict" delete: tags: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ /cloud-infrastructure/complexes/complex/{physical-location-id}: get: tags: - CloudInfrastructure summary: returns complex description: returns complex operationId: getCloudInfrastructureComplexesComplex produces: - application/json - application/xml responses: "200": description: successful operation schema: $ref: "#/getDefinitions/complex" "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ put: tags: - CloudInfrastructure summary: create or update an existing complex description: | Create or update an existing complex. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureComplexesComplex consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: body in: body description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json) required: true schema: $ref: "#/definitions/complex" patch: tags: - CloudInfrastructure summary: update an existing complex description: | Update an existing complex # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureComplexesComplex consumes: - application/json produces: - application/json responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: body in: body description: complex object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/complex" delete: tags: - CloudInfrastructure summary: delete an existing complex description: delete an existing complex operationId: deleteCloudInfrastructureComplexesComplex consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string /cloud-infrastructure/complexes: get: tags: - CloudInfrastructure summary: returns complexes description: returns complexes operationId: getCloudInfrastructureComplexes produces: - application/json - application/xml responses: "200": description: successful operation schema: $ref: "#/getDefinitions/complexes" "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: physical-location-id in: query description: required: false type: string - name: data-center-code in: query description: required: false type: string - name: complex-name in: query description: required: false type: string - name: identity-url in: query description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string example: __VOLUME-GROUP-ID__ - name: body in: body description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) required: true schema: $ref: "#/definitions/relationship-dict" delete: tags: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string example: __VOLUME-GROUP-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}: get: tags: - CloudInfrastructure summary: returns volume-group description: returns volume-group operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup produces: - application/json - application/xml responses: "200": description: successful operation schema: $ref: "#/getDefinitions/volume-group" "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string example: __VOLUME-GROUP-ID__ put: tags: - CloudInfrastructure summary: create or update an existing volume-group description: | Create or update an existing volume-group. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string example: __VOLUME-GROUP-ID__ - name: body in: body description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) required: true schema: $ref: "#/definitions/volume-group" patch: tags: - CloudInfrastructure summary: update an existing volume-group description: | Update an existing volume-group # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup consumes: - application/json produces: - application/json responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string example: __VOLUME-GROUP-ID__ - name: body in: body description: volume-group object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/volume-group" delete: tags: - CloudInfrastructure summary: delete an existing volume-group description: delete an existing volume-group operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string example: __VOLUME-GROUP-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups: get: tags: - CloudInfrastructure summary: returns volume-groups description: returns volume-groups operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups produces: - application/json - application/xml responses: "200": description: successful operation schema: $ref: "#/getDefinitions/volume-groups" "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: volume-group-id in: query description: required: false type: string - name: volume-group-name in: query description: required: false type: string - name: heat-stack-id in: query description: required: false type: string - name: vnf-type in: query description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string example: __VOLUME-ID__ - name: body in: body description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: $ref: "#/definitions/relationship-dict" delete: tags: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string example: __VOLUME-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}: get: tags: - CloudInfrastructure summary: returns volume description: returns volume operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume produces: - application/json - application/xml responses: "200": description: successful operation schema: $ref: "#/getDefinitions/volume" "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string example: __VOLUME-ID__ put: tags: - CloudInfrastructure summary: create or update an existing volume description: | Create or update an existing volume. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string example: __VOLUME-ID__ - name: body in: body description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: $ref: "#/definitions/volume" patch: tags: - CloudInfrastructure summary: update an existing volume description: | Update an existing volume # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume consumes: - application/json produces: - application/json responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string example: __VOLUME-ID__ - name: body in: body description: volume object that needs to be updated. required: true schema: $ref: "#/patchDefinitions/volume" delete: tags: - CloudInfrastructure summary: delete an existing volume description: delete an existing volume operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string example: __VOLUME-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes: get: tags: - CloudInfrastructure summary: returns volumes description: returns volumes operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes produces: - application/json - application/xml responses: "200": description: successful operation schema: $ref: "#/getDefinitions/volumes" "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ - name: volume-id in: query description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ - name: body in: body description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship-dict" delete: tags: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string example: __VSERVER-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml produces: - application/json - application/xml responses: "default": description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Uniqu