description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __FLAVOR-ID__
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __FLAVOR-ID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute:
get:
tags:
- CloudInfrastructure
- summary: returns flavor
- description: returns flavor
- operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
+ summary: returns hpa-feature-attribute
+ description: returns hpa-feature-attribute
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/flavor"
+ $ref: "#/getDefinitions/hpa-feature-attribute"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __FLAVOR-ID__
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
type: string
- name: flavor-name
in: query
- description: Flavor name
+ description: Cloud Region Flavor name
+ required: false
+ type: string
+ - name: hpa-feature
+ in: query
+ description: Name of the HPACapability
+ required: false
+ type: string
+ - name: hpa-hw-arch
+ in: query
+ description: Hardware architecture
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns hpa-capability
+ description: returns hpa-capability
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/hpa-capability"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: flavor-name
+ in: query
+ description: Cloud Region Flavor name
+ required: false
+ type: string
+ - name: hpa-feature
+ in: query
+ description: Name of the HPACapability
+ required: false
+ type: string
+ - name: hpa-hw-arch
+ in: query
+ description: Hardware architecture
required: false
type: string
put:
tags:
- CloudInfrastructure
- summary: create or update an existing flavor
+ summary: create or update an existing hpa-capability
description: |
- Create or update an existing flavor.
+ Create or update an existing hpa-capability.
#
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
consumes:
- application/json
- application/xml
required: true
type: string
example: __FLAVOR-ID__
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
- name: body
in: body
- description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
+ description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
required: true
schema:
- $ref: "#/definitions/flavor"
+ $ref: "#/definitions/hpa-capability"
patch:
tags:
- CloudInfrastructure
- summary: update an existing flavor
+ summary: update an existing hpa-capability
description: |
- Update an existing flavor
+ Update an existing hpa-capability
#
Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
The PUT operation will entirely replace an existing object.
- 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: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
consumes:
- application/json
- application/xml
required: true
type: string
example: __FLAVOR-ID__
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
- name: body
in: body
- description: flavor object that needs to be created or updated.
+ description: hpa-capability object that needs to be created or updated.
required: true
schema:
- $ref: "#/patchDefinitions/flavor"
+ $ref: "#/patchDefinitions/hpa-capability"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing flavor
- description: delete an existing flavor
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
+ summary: delete an existing hpa-capability
+ description: delete an existing hpa-capability
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
consumes:
- application/json
- application/xml
required: true
type: string
example: __FLAVOR-ID__
+ - name: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-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}/flavors:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities:
get:
tags:
- CloudInfrastructure
- summary: returns flavors
- description: returns flavors
- operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
+ summary: returns hpa-capabilities
+ description: returns hpa-capabilities
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/flavors"
+ $ref: "#/getDefinitions/hpa-capabilities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
+ - name: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
+ - name: flavor-name
+ in: query
+ description: Cloud Region Flavor name
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: group-id
+ - name: flavor-id
in: path
- description: Group id, expected to be unique across cloud-region.
+ description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
- example: __GROUP-ID__
+ example: __FLAVOR-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: group-id
+ - name: flavor-id
in: path
- description: Group id, expected to be unique across cloud-region.
+ description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
- example: __GROUP-ID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
+ example: __FLAVOR-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
get:
tags:
- CloudInfrastructure
- summary: returns group-assignment
- description: returns group-assignment
- operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
+ summary: returns flavor
+ description: returns flavor
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/group-assignment"
+ $ref: "#/getDefinitions/flavor"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: group-id
+ - name: flavor-id
in: path
- description: Group id, expected to be unique across cloud-region.
+ description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
- example: __GROUP-ID__
+ example: __FLAVOR-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- - name: group-type
- in: query
- description: Group type - the type of group this instance refers to
- required: false
- type: string
- - name: group-name
+ - name: flavor-name
in: query
- description: Group name - name assigned to the group
+ description: Cloud Region Flavor name
required: false
type: string
put:
tags:
- CloudInfrastructure
- summary: create or update an existing group-assignment
+ summary: create or update an existing flavor
description: |
- Create or update an existing group-assignment.
+ Create or update an existing flavor.
#
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: group-id
+ - name: flavor-id
in: path
- description: Group id, expected to be unique across cloud-region.
+ description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
- example: __GROUP-ID__
+ example: __FLAVOR-ID__
- name: body
in: body
- description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
+ description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
required: true
schema:
- $ref: "#/definitions/group-assignment"
+ $ref: "#/definitions/flavor"
patch:
tags:
- CloudInfrastructure
- summary: update an existing group-assignment
+ summary: update an existing flavor
description: |
- Update an existing group-assignment
+ Update an existing flavor
#
Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
The PUT operation will entirely replace an existing object.
- 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: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: group-id
+ - name: flavor-id
in: path
- description: Group id, expected to be unique across cloud-region.
+ description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
- example: __GROUP-ID__
+ example: __FLAVOR-ID__
- name: body
in: body
- description: group-assignment object that needs to be created or updated.
+ description: flavor object that needs to be created or updated.
required: true
schema:
- $ref: "#/patchDefinitions/group-assignment"
+ $ref: "#/patchDefinitions/flavor"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing group-assignment
- description: delete an existing group-assignment
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
+ summary: delete an existing flavor
+ description: delete an existing flavor
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: group-id
+ - name: flavor-id
in: path
- description: Group id, expected to be unique across cloud-region.
+ description: Flavor id, expected to be unique across cloud-region.
required: true
type: string
- example: __GROUP-ID__
+ example: __FLAVOR-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}/group-assignments:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
get:
tags:
- CloudInfrastructure
- summary: returns group-assignments
- description: returns group-assignments
- operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
+ summary: returns flavors
+ description: returns flavors
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/group-assignments"
+ $ref: "#/getDefinitions/flavors"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: snapshot-id
+ - name: group-id
in: path
- description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ description: Group id, expected to be unique across cloud-region.
required: true
type: string
- example: __SNAPSHOT-ID__
+ example: __GROUP-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: snapshot-id
+ - name: group-id
in: path
- description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ description: Group id, expected to be unique across cloud-region.
required: true
type: string
- example: __SNAPSHOT-ID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
+ example: __GROUP-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
get:
tags:
- CloudInfrastructure
- summary: returns snapshot
- description: returns snapshot
- operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ summary: returns group-assignment
+ description: returns group-assignment
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/snapshot"
+ $ref: "#/getDefinitions/group-assignment"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: snapshot-id
+ - name: group-id
in: path
- description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ description: Group id, expected to be unique across cloud-region.
required: true
type: string
- example: __SNAPSHOT-ID__
+ example: __GROUP-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- - name: snapshot-name
- in: query
- description: Snapshot name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
+ - name: group-type
in: query
- description: The version of the application.
+ description: Group type - the type of group this instance refers to
required: false
type: string
- - name: prev-snapshot-id
+ - name: group-name
in: query
- description: This field contains the UUID of the previous snapshot (if any).
+ description: Group name - name assigned to the group
required: false
type: string
put:
tags:
- CloudInfrastructure
- summary: create or update an existing snapshot
+ summary: create or update an existing group-assignment
description: |
- Create or update an existing snapshot.
+ Create or update an existing group-assignment.
#
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: snapshot-id
+ - name: group-id
in: path
- description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ description: Group id, expected to be unique across cloud-region.
required: true
type: string
- example: __SNAPSHOT-ID__
+ example: __GROUP-ID__
- name: body
in: body
- description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
+ description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
required: true
schema:
- $ref: "#/definitions/snapshot"
+ $ref: "#/definitions/group-assignment"
patch:
tags:
- CloudInfrastructure
- summary: update an existing snapshot
+ summary: update an existing group-assignment
description: |
- Update an existing snapshot
+ Update an existing group-assignment
#
Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
The PUT operation will entirely replace an existing object.
- 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: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: snapshot-id
+ - name: group-id
in: path
- description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ description: Group id, expected to be unique across cloud-region.
required: true
type: string
- example: __SNAPSHOT-ID__
+ example: __GROUP-ID__
- name: body
in: body
- description: snapshot object that needs to be created or updated.
+ description: group-assignment object that needs to be created or updated.
required: true
schema:
- $ref: "#/patchDefinitions/snapshot"
+ $ref: "#/patchDefinitions/group-assignment"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing snapshot
- description: delete an existing snapshot
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ summary: delete an existing group-assignment
+ description: delete an existing group-assignment
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: snapshot-id
+ - name: group-id
in: path
- description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ description: Group id, expected to be unique across cloud-region.
required: true
type: string
- example: __SNAPSHOT-ID__
+ example: __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}/snapshots:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
get:
tags:
- CloudInfrastructure
- summary: returns snapshots
- description: returns snapshots
- operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
+ summary: returns group-assignments
+ description: returns group-assignments
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/snapshots"
+ $ref: "#/getDefinitions/group-assignments"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: image-id
+ - name: snapshot-id
in: path
- description: Image id, expected to be unique across cloud region
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- example: __IMAGE-ID__
+ example: __SNAPSHOT-ID__
- name: body
in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: image-id
+ - name: snapshot-id
in: path
- description: Image id, expected to be unique across cloud region
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- example: __IMAGE-ID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
+ example: __SNAPSHOT-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
get:
tags:
- CloudInfrastructure
- summary: returns metadatum
- description: returns metadatum
- operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ summary: returns snapshot
+ description: returns snapshot
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/metadatum"
+ $ref: "#/getDefinitions/snapshot"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: image-id
- in: path
- description: Image id, expected to be unique across cloud region
- required: true
- type: string
- example: __IMAGE-ID__
- - name: metaname
+ - name: snapshot-id
in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- example: __METANAME__
+ example: __SNAPSHOT-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- - name: image-name
+ - name: snapshot-name
in: query
- description: Image name
+ description: Snapshot name
required: false
type: string
- name: application
description: The version of the application.
required: false
type: string
+ - name: prev-snapshot-id
+ in: query
+ description: This field contains the UUID of the previous snapshot (if any).
+ required: false
+ type: string
put:
tags:
- CloudInfrastructure
- summary: create or update an existing metadatum
+ summary: create or update an existing snapshot
description: |
- Create or update an existing metadatum.
+ Create or update an existing snapshot.
#
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: image-id
- in: path
- description: Image id, expected to be unique across cloud region
- required: true
- type: string
- example: __IMAGE-ID__
- - name: metaname
+ - name: snapshot-id
in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- example: __METANAME__
+ example: __SNAPSHOT-ID__
- name: body
in: body
- description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
+ description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
required: true
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/snapshot"
patch:
tags:
- CloudInfrastructure
- summary: update an existing metadatum
+ summary: update an existing snapshot
description: |
- Update an existing metadatum
+ Update an existing snapshot
#
Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
The PUT operation will entirely replace an existing object.
- 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: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: image-id
- in: path
- description: Image id, expected to be unique across cloud region
- required: true
- type: string
- example: __IMAGE-ID__
- - name: metaname
+ - name: snapshot-id
in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- example: __METANAME__
+ example: __SNAPSHOT-ID__
- name: body
in: body
- description: metadatum object that needs to be created or updated.
+ description: snapshot object that needs to be created or updated.
required: true
schema:
- $ref: "#/patchDefinitions/metadatum"
+ $ref: "#/patchDefinitions/snapshot"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing metadatum
- description: delete an existing metadatum
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ summary: delete an existing snapshot
+ description: delete an existing snapshot
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: image-id
- in: path
- description: Image id, expected to be unique across cloud region
- required: true
- type: string
- example: __IMAGE-ID__
- - name: metaname
+ - name: snapshot-id
in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
required: true
type: string
- example: __METANAME__
+ example: __SNAPSHOT-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}/images/image/{image-id}/metadata:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
get:
tags:
- CloudInfrastructure
- summary: returns metadata
- description: returns metadata
- operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
+ summary: returns snapshots
+ description: returns snapshots
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/metadata"
+ $ref: "#/getDefinitions/snapshots"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: image-id
- in: path
- description: Image id, expected to be unique across cloud region
- required: true
- type: string
- example: __IMAGE-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- - name: image-name
- in: query
- description: Image name
- required: false
- type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
- get:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
+ put:
tags:
- CloudInfrastructure
- summary: returns image
- description: returns image
- operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/image"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __IMAGE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
put:
tags:
- CloudInfrastructure
- summary: create or update an existing image
+ summary: create or update an existing metadatum
description: |
- Create or update an existing image.
+ Create or update an existing metadatum.
#
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
consumes:
- application/json
- application/xml
required: true
type: string
example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
- name: body
in: body
- description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
required: true
schema:
- $ref: "#/definitions/image"
+ $ref: "#/definitions/metadatum"
patch:
tags:
- CloudInfrastructure
- summary: update an existing image
+ summary: update an existing metadatum
description: |
- Update an existing image
+ Update an existing metadatum
#
Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
The PUT operation will entirely replace an existing object.
- 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: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
consumes:
- application/json
- application/xml
required: true
type: string
example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
- name: body
in: body
- description: image object that needs to be created or updated.
+ description: metadatum object that needs to be created or updated.
required: true
schema:
- $ref: "#/patchDefinitions/image"
+ $ref: "#/patchDefinitions/metadatum"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing image
- description: delete an existing image
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
consumes:
- application/json
- application/xml
required: true
type: string
example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
- 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}/images:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
get:
tags:
- CloudInfrastructure
- summary: returns images
- description: returns images
- operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
+ summary: returns metadata
+ description: returns metadata
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/images"
+ $ref: "#/getDefinitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
- put:
- tags:
- - CloudInfrastructure
- summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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: switch-name
- in: path
- description: DVS switch name
- required: true
+ - name: image-name
+ in: query
+ description: Image name
+ required: false
type: string
- example: __SWITCH-NAME__
- - name: body
- in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
- tags:
- - CloudInfrastructure
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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
+ - name: application
+ in: query
+ description: The application that the image instantiates.
+ required: false
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
+ - name: application-vendor
+ in: query
+ description: The vendor of the application.
+ required: false
type: string
- example: __CLOUD-REGION-ID__
- - name: switch-name
- in: path
- description: DVS switch name
- required: true
+ - name: application-version
+ in: query
+ description: The version of the application.
+ required: false
type: string
- example: __SWITCH-NAME__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
get:
tags:
- CloudInfrastructure
- summary: returns dvs-switch
- description: returns dvs-switch
- operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ summary: returns image
+ description: returns image
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/dvs-switch"
+ $ref: "#/getDefinitions/image"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: switch-name
+ - name: image-id
in: path
- description: DVS switch name
+ description: Image id, expected to be unique across cloud region
required: true
type: string
- example: __SWITCH-NAME__
+ example: __IMAGE-ID__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- - name: vcenter-url
+ - name: image-name
in: query
- description: URL used to reach the vcenter
+ description: Image name
+ required: false
+ type: string
+ - name: application
+ in: query
+ description: The application that the image instantiates.
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description: The vendor of the application.
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description: The version of the application.
required: false
type: string
put:
tags:
- CloudInfrastructure
- summary: create or update an existing dvs-switch
+ summary: create or update an existing image
description: |
- Create or update an existing dvs-switch.
+ Create or update an existing image.
#
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: switch-name
+ - name: image-id
in: path
- description: DVS switch name
+ description: Image id, expected to be unique across cloud region
required: true
type: string
- example: __SWITCH-NAME__
+ example: __IMAGE-ID__
- name: body
in: body
- description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
+ description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
required: true
schema:
- $ref: "#/definitions/dvs-switch"
+ $ref: "#/definitions/image"
patch:
tags:
- CloudInfrastructure
- summary: update an existing dvs-switch
+ summary: update an existing image
description: |
- Update an existing dvs-switch
+ Update an existing image
#
Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
The PUT operation will entirely replace an existing object.
- 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: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: switch-name
+ - name: image-id
in: path
- description: DVS switch name
+ description: Image id, expected to be unique across cloud region
required: true
type: string
- example: __SWITCH-NAME__
+ example: __IMAGE-ID__
- name: body
in: body
- description: dvs-switch object that needs to be created or updated.
+ description: image object that needs to be created or updated.
required: true
schema:
- $ref: "#/patchDefinitions/dvs-switch"
+ $ref: "#/patchDefinitions/image"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing dvs-switch
- description: delete an existing dvs-switch
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ summary: delete an existing image
+ description: delete an existing image
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: switch-name
+ - name: image-id
in: path
- description: DVS switch name
+ description: Image id, expected to be unique across cloud region
required: true
type: string
- example: __SWITCH-NAME__
+ example: __IMAGE-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}/dvs-switches:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
get:
tags:
- CloudInfrastructure
- summary: returns dvs-switches
- description: returns dvs-switches
- operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
+ summary: returns images
+ description: returns images
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/dvs-switches"
+ $ref: "#/getDefinitions/images"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: network-uuid
+ - name: switch-name
in: path
- description: UUID of the network. Unique across a cloud-region
+ description: DVS switch name
required: true
type: string
- example: __NETWORK-UUID__
+ example: __SWITCH-NAME__
- name: body
in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: network-uuid
+ - name: switch-name
in: path
- description: UUID of the network. Unique across a cloud-region
+ description: DVS switch name
required: true
type: string
- example: __NETWORK-UUID__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
+ example: __SWITCH-NAME__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
get:
tags:
- CloudInfrastructure
- summary: returns oam-network
- description: returns oam-network
- operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ summary: returns dvs-switch
+ description: returns dvs-switch
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/oam-network"
+ $ref: "#/getDefinitions/dvs-switch"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: network-uuid
+ - name: switch-name
in: path
- description: UUID of the network. Unique across a cloud-region
+ description: DVS switch name
required: true
type: string
- example: __NETWORK-UUID__
+ example: __SWITCH-NAME__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- - name: network-name
+ - name: vcenter-url
in: query
- description: Name of the network.
+ description: URL used to reach the vcenter
required: false
type: string
- - name: cvlan-tag
- in: query
- description: cvlan-id
- required: false
- type: integer
- format: int64
put:
tags:
- CloudInfrastructure
- summary: create or update an existing oam-network
+ summary: create or update an existing dvs-switch
description: |
- Create or update an existing oam-network.
+ Create or update an existing dvs-switch.
#
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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: network-uuid
+ - name: switch-name
in: path
- description: UUID of the network. Unique across a cloud-region
+ description: DVS switch name
required: true
type: string
- example: __NETWORK-UUID__
+ example: __SWITCH-NAME__
- name: body
in: body
- description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
+ description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
required: true
schema:
- $ref: "#/definitions/oam-network"
+ $ref: "#/definitions/dvs-switch"
patch:
tags:
- CloudInfrastructure
- summary: update an existing oam-network
+ summary: update an existing dvs-switch
description: |
- Update an existing oam-network
+ Update an existing dvs-switch
#
Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
The PUT operation will entirely replace an existing object.
- 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: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: network-uuid
+ - name: switch-name
in: path
- description: UUID of the network. Unique across a cloud-region
+ description: DVS switch name
required: true
type: string
- example: __NETWORK-UUID__
+ example: __SWITCH-NAME__
- name: body
in: body
- description: oam-network object that needs to be created or updated.
+ description: dvs-switch object that needs to be created or updated.
required: true
schema:
- $ref: "#/patchDefinitions/oam-network"
+ $ref: "#/patchDefinitions/dvs-switch"
delete:
tags:
- CloudInfrastructure
- summary: delete an existing oam-network
- description: delete an existing oam-network
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ summary: delete an existing dvs-switch
+ description: delete an existing dvs-switch
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: network-uuid
+ - name: switch-name
in: path
- description: UUID of the network. Unique across a cloud-region
+ description: DVS switch name
required: true
type: string
- example: __NETWORK-UUID__
+ example: __SWITCH-NAME__
- 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}/oam-networks:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
get:
tags:
- CloudInfrastructure
- summary: returns oam-networks
- description: returns oam-networks
- operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
+ summary: returns dvs-switches
+ description: returns dvs-switches
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/oam-networks"
+ $ref: "#/getDefinitions/dvs-switches"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
put:
tags:
- CloudInfrastructure
summary: see node definition for valid relationships
- operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: availability-zone-name
+ - name: network-uuid
in: path
- description: Name of the availability zone. Unique across a cloud region
+ description: UUID of the network. Unique across a cloud-region
required: true
type: string
- example: __AVAILABILITY-ZONE-NAME__
+ example: __NETWORK-UUID__
- name: body
in: body
- description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
required: true
schema:
$ref: "#/definitions/relationship"
- CloudInfrastructure
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns oam-network
+ description: returns oam-network
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/oam-network"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network.
+ required: false
+ type: string
+ - name: cvlan-tag
+ in: query
+ description: cvlan-id
+ required: false
+ type: integer
+ format: int64
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing oam-network
+ description: |
+ Create or update an existing oam-network.
+ #
+ 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: body
+ in: body
+ description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
+ required: true
+ schema:
+ $ref: "#/definitions/oam-network"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing oam-network
+ description: |
+ Update an existing oam-network
+ #
+ 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: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: body
+ in: body
+ description: oam-network object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/oam-network"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing oam-network
+ description: delete an existing oam-network
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - 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}/oam-networks:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns oam-networks
+ description: returns oam-networks
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/oam-networks"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: availability-zone-name
+ in: path
+ description: Name of the availability zone. Unique across a cloud region
+ 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/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
consumes:
- application/json
- application/xml
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: vip-ipv6-address
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vip-ipv6-address-list
+ description: returns vip-ipv6-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vip-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing vip-ipv6-address-list
+ description: |
+ Create or update an existing vip-ipv6-address-list.
+ #
+ 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vip-ipv6-address-list
+ description: |
+ Update an existing vip-ipv6-address-list
+ #
+ 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: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: vip-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vip-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing vip-ipv6-address-list
+ description: delete an existing vip-ipv6-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - 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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns hpa-feature-attribute
+ description: returns hpa-feature-attribute
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/hpa-feature-attribute"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: hpa-feature
+ in: query
+ description: Name of the HPACapability
+ required: false
+ type: string
+ - name: hpa-hw-arch
+ in: query
+ description: Hardware architecture
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns hpa-capability
+ description: returns hpa-capability
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/hpa-capability"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: hpa-feature
+ in: query
+ description: Name of the HPACapability
+ required: false
+ type: string
+ - name: hpa-hw-arch
+ in: query
+ description: Hardware architecture
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing hpa-capability
+ description: |
+ Create or update an existing hpa-capability.
+ #
+ 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: body
+ in: body
+ description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
+ required: true
+ schema:
+ $ref: "#/definitions/hpa-capability"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing hpa-capability
+ description: |
+ Update an existing hpa-capability
+ #
+ 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: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
+ in: path
+ description: UUID to uniquely identify a HPA capability
+ required: true
+ type: string
+ example: __HPA-CAPABILITY-ID__
+ - name: body
+ in: body
+ description: hpa-capability object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/hpa-capability"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing hpa-capability
+ description: delete an existing hpa-capability
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ 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: hpa-capability-id
in: path
- description: IP address
+ description: UUID to uniquely identify a HPA capability
required: true
type: string
- example: __VIP-IPV6-ADDRESS__
- /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
+ example: __HPA-CAPABILITY-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}/hpa-capabilities:
get:
tags:
- CloudInfrastructure
- summary: returns vip-ipv6-address-list
- description: returns vip-ipv6-address-list
- operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ summary: returns hpa-capabilities
+ description: returns hpa-capabilities
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/getDefinitions/vip-ipv6-address-list"
+ $ref: "#/getDefinitions/hpa-capabilities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
required: true
type: string
example: __CLOUD-REGION-ID__
- - name: vip-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- example: __VIP-IPV6-ADDRESS__
- name: cloud-type
in: query
description: Type of the cloud (e.g., openstack)
description: Cloud-owner defined type indicator (e.g., dcp, lcp)
required: false
type: string
- - name: vlan-id-inner
- in: query
- description: Inner VLAN tag
- required: false
- type: integer
- format: int64
- - name: neutron-network-id
- in: query
- description: Neutron network id of the interface that address belongs to
- required: false
- type: string
- - name: neutron-subnet-id
- in: query
- description: Neutron id of subnet that address belongs to
- required: false
- type: string
- put:
- tags:
- - CloudInfrastructure
- summary: create or update an existing vip-ipv6-address-list
- description: |
- Create or update an existing vip-ipv6-address-list.
- #
- 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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: vip-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- example: __VIP-IPV6-ADDRESS__
- - name: body
- in: body
- description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
- required: true
- schema:
- $ref: "#/definitions/vip-ipv6-address-list"
- patch:
- tags:
- - CloudInfrastructure
- summary: update an existing vip-ipv6-address-list
- description: |
- Update an existing vip-ipv6-address-list
- #
- 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: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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: vip-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- example: __VIP-IPV6-ADDRESS__
- - name: body
- in: body
- description: vip-ipv6-address-list object that needs to be created or updated.
- required: true
- schema:
- $ref: "#/patchDefinitions/vip-ipv6-address-list"
- delete:
- tags:
- - CloudInfrastructure
- summary: delete an existing vip-ipv6-address-list
- description: delete an existing vip-ipv6-address-list
- operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- 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: vip-ipv6-address
- in: path
- description: IP address
- required: true
- type: string
- example: __VIP-IPV6-ADDRESS__
- - 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}:
get:
tags:
- FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
- FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
- - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
- CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
- CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
required:
type: array
items:
$ref: "#/definitions/vip-ipv6-address-list"
+ hpa-capabilities:
+ type: array
+ items:
+ $ref: "#/definitions/hpa-capability"
+ description: List of cloud-region specific HPA Capabilities
cloud-regions:
properties:
cloud-region:
Openstack flavor.
###### Related Nodes
- TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
- FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
- - FLAVOR cannot be deleted if linked to VSERVER
+ - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
required:
- flavor-id
- flavor-name
description: Flavor id, expected to be unique across cloud-region.
flavor-name:
type: string
- description: Flavor name
+ description: Cloud Region Flavor name
flavor-vcpus:
type: integer
format: int32
flavor-disabled:
type: boolean
description: Boolean as to whether this flavor is no longer enabled
+ hpa-capabilities:
+ type: array
+ items:
+ $ref: "#/definitions/hpa-capability"
+ description: List of flavor specific HPA Capabilities
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/host-route"
+ hpa-capabilities:
+ description: |
+ Collection of HPA Capabilities
+ properties:
+ hpa-capability:
+ type: array
+ items:
+ $ref: "#/definitions/hpa-capability"
+ hpa-capability:
+ description: |
+ Represents a HPA capability
+ ###### Related Nodes
+ - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ required:
+ - hpa-capability-id
+ - hpa-feature
+ properties:
+ hpa-capability-id:
+ type: string
+ description: UUID to uniquely identify a HPA capability
+ hpa-feature:
+ type: string
+ description: Name of the HPACapability
+ hpa-version:
+ type: string
+ description: HPA schema version
+ hpa-hw-arch:
+ type: string
+ description: Hardware architecture
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ hpa-feature-attribute:
+ type: array
+ items:
+ $ref: "#/definitions/hpa-feature-attribute"
+ hpa-feature-attribute:
+ description: |
+ HPA Capability Feature attributes
+ properties:
+ hpa-attr-key:
+ type: string
+ description: name of the specific HPA attribute
+ hpa-attr-value:
+ type: string
+ description: JSON string specifying the value, unit and type of the specific HPA attribute
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
image:
description: |
Openstack image.
- FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
- FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
- - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
- CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
- CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
required:
Openstack flavor.
###### Related Nodes
- TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
- FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
- - FLAVOR cannot be deleted if linked to VSERVER
+ - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
required:
- flavor-id
- flavor-name
description: Flavor id, expected to be unique across cloud-region.
flavor-name:
type: string
- description: Flavor name
+ description: Cloud Region Flavor name
flavor-vcpus:
type: integer
format: int32
flavor-disabled:
type: boolean
description: Boolean as to whether this flavor is no longer enabled
+ hpa-capabilities:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/hpa-capability"
+ description: List of flavor specific HPA Capabilities
flavors:
description: |
Collection of openstack flavors.
type: array
items:
$ref: "#/patchDefinitions/host-route"
+ hpa-capabilities:
+ description: |
+ Collection of HPA Capabilities
+ properties:
+ hpa-capability:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/hpa-capability"
+ hpa-capability:
+ description: |
+ Represents a HPA capability
+ ###### Related Nodes
+ - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ required:
+ - hpa-capability-id
+ - hpa-feature
+ properties:
+ hpa-capability-id:
+ type: string
+ description: UUID to uniquely identify a HPA capability
+ hpa-feature:
+ type: string
+ description: Name of the HPACapability
+ hpa-version:
+ type: string
+ description: HPA schema version
+ hpa-hw-arch:
+ type: string
+ description: Hardware architecture
+ hpa-feature-attribute:
+ description: |
+ HPA Capability Feature attributes
+ properties:
+ hpa-attr-key:
+ type: string
+ description: name of the specific HPA attribute
+ hpa-attr-value:
+ type: string
+ description: JSON string specifying the value, unit and type of the specific HPA attribute
image:
description: |
Openstack image.
- FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
- FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
- FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
- - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
- CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
- CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
required:
type: array
items:
$ref: "#/getDefinitions/vip-ipv6-address-list"
+ hpa-capabilities:
+ type: array
+ items:
+ $ref: "#/getDefinitions/hpa-capability"
+ description: List of cloud-region specific HPA Capabilities
cloud-regions:
properties:
cloud-region:
Openstack flavor.
###### Related Nodes
- TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
- FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
- - FLAVOR cannot be deleted if linked to VSERVER
+ - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
required:
- flavor-id
- flavor-name
description: Flavor id, expected to be unique across cloud-region.
flavor-name:
type: string
- description: Flavor name
+ description: Cloud Region Flavor name
flavor-vcpus:
type: integer
format: int32
flavor-disabled:
type: boolean
description: Boolean as to whether this flavor is no longer enabled
+ hpa-capabilities:
+ type: array
+ items:
+ $ref: "#/getDefinitions/hpa-capability"
+ description: List of flavor specific HPA Capabilities
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/getDefinitions/host-route"
+ hpa-capabilities:
+ description: |
+ Collection of HPA Capabilities
+ properties:
+ hpa-capability:
+ type: array
+ items:
+ $ref: "#/getDefinitions/hpa-capability"
+ hpa-capability:
+ description: |
+ Represents a HPA capability
+ ###### Related Nodes
+ - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
+ - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ required:
+ - hpa-capability-id
+ - hpa-feature
+ properties:
+ hpa-capability-id:
+ type: string
+ description: UUID to uniquely identify a HPA capability
+ hpa-feature:
+ type: string
+ description: Name of the HPACapability
+ hpa-version:
+ type: string
+ description: HPA schema version
+ hpa-hw-arch:
+ type: string
+ description: Hardware architecture
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ hpa-feature-attribute:
+ type: array
+ items:
+ $ref: "#/getDefinitions/hpa-feature-attribute"
+ hpa-feature-attribute:
+ description: |
+ HPA Capability Feature attributes
+ properties:
+ hpa-attr-key:
+ type: string
+ description: name of the specific HPA attribute
+ hpa-attr-value:
+ type: string
+ description: JSON string specifying the value, unit and type of the specific HPA attribute
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
image:
description: |
Openstack image.