application_vips

Creates, updates, deletes, gets or lists an application_vips resource.

Overview

Name	application_vips
Type	Resource
Id	oci.database.application_vips

Fields

The following fields are returned by SELECT queries:

get

The application virtual IP (VIP) address details.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address.
cloudVmClusterId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
hostnameLabel	string	The hostname of the application virtual IP (VIP) address.
ipAddress	string	The application virtual IP (VIP) address.
lifecycleDetails	string	Additional information about the current lifecycle state of the application virtual IP (VIP) address.
lifecycleState	string	The current lifecycle state of the application virtual IP (VIP) address. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED, FAILED)
subnetId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address.
timeAssigned	string (date-time)	The date and time when the create operation for the application virtual IP (VIP) address completed.

list

Details of an application virtual IP (VIP) address.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address.
cloudVmClusterId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
hostnameLabel	string	The hostname of the application virtual IP (VIP) address.
ipAddress	string	The application virtual IP (VIP) address.
lifecycleDetails	string	Additional information about the current lifecycle state of the application virtual IP (VIP) address.
lifecycleState	string	The current lifecycle state of the application virtual IP (VIP) address. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED, FAILED)
subnetId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address.
timeAssigned	string (date-time)	The date and time when the create operation for the application virtual IP (VIP) address completed.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	applicationVipId, region	opc-request-id	Gets information about a specified application virtual IP (VIP) address.
list	select	compartmentId, cloudVmClusterId, region	limit, page, opc-request-id, sortOrder, sortBy, lifecycleState	Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster.<br />
create	insert	region, hostnameLabel, cloudVmClusterId	opc-retry-token, opc-request-id	Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide.<br />
delete	delete	applicationVipId, region	if-match, opc-request-id	Deletes and deregisters the specified application virtual IP (VIP) address.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
applicationVipId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address.
cloudVmClusterId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address.
compartmentId	string	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleState	string	A filter to return only resources that match the given lifecycle state exactly.
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	The pagination token to continue listing from.
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples

get

Gets information about a specified application virtual IP (VIP) address.

SELECT
id,
cloudVmClusterId,
compartmentId,
definedTags,
freeformTags,
hostnameLabel,
ipAddress,
lifecycleDetails,
lifecycleState,
subnetId,
timeAssigned
FROM oci.database.application_vips
WHERE applicationVipId = '{{ applicationVipId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster.<br />

SELECT
id,
cloudVmClusterId,
compartmentId,
definedTags,
freeformTags,
hostnameLabel,
ipAddress,
lifecycleDetails,
lifecycleState,
subnetId,
timeAssigned
FROM oci.database.application_vips
WHERE compartmentId = '{{ compartmentId }}' -- required
AND cloudVmClusterId = '{{ cloudVmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
AND lifecycleState = '{{ lifecycleState }}'
;

INSERT examples

create

Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide.<br />

INSERT INTO oci.database.application_vips (
cloudVmClusterId,
dbNodeId,
hostnameLabel,
ipAddress,
subnetId,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ cloudVmClusterId }}' /* required */,
'{{ dbNodeId }}',
'{{ hostnameLabel }}' /* required */,
'{{ ipAddress }}',
'{{ subnetId }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
cloudVmClusterId,
compartmentId,
definedTags,
freeformTags,
hostnameLabel,
ipAddress,
lifecycleDetails,
lifecycleState,
subnetId,
timeAssigned
;

Manifest

# Description fields are for documentation purposes
- name: application_vips
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the application_vips resource.
  - name: cloudVmClusterId
    value: "{{ cloudVmClusterId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address.
  - name: dbNodeId
    value: "{{ dbNodeId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the DB node associated with the application virtual IP (VIP) address.
  - name: hostnameLabel
    value: "{{ hostnameLabel }}"
    description: |
      The hostname of the application virtual IP (VIP) address.
  - name: ipAddress
    value: "{{ ipAddress }}"
    description: |
      The application virtual IP (VIP) address.
  - name: subnetId
    value: "{{ subnetId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

DELETE examples

delete

Deletes and deregisters the specified application virtual IP (VIP) address.<br />

DELETE FROM oci.database.application_vips
WHERE applicationVipId = '{{ applicationVipId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;