networking_topologies
Creates, updates, deletes, gets or lists a networking_topologies resource.
Overview​
| Name | networking_topologies |
| Type | Resource |
| Id | oci.network.networking_topologies |
Fields​
The following fields are returned by SELECT queries:
- get
The topology was successfully returned.
| Name | Datatype | Description |
|---|---|---|
entities | array | Lists entities comprising the virtual network topology. |
limitedEntities | array | Lists entities that are limited during ingestion. The values for the items in the list are the entity type names of the limitedEntities. Example: vcn |
relationships | array | Lists relationships between entities in the virtual network topology. |
timeCreated | string (date-time) | Records when the virtual network topology was created, in [RFC3339](https:​//tools.ietf.org/html/rfc3339) format for date and time. |
type | string | Type of the topology object. (NETWORKING, VCN, SUBNET, PATH) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | compartmentId, region | accessLevel, queryCompartmentSubtree, opc-request-id, if-none-match, cache-control | Gets a virtual networking topology for the current region. |
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 |
|---|---|---|
compartmentId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. |
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) |
accessLevel | string | Valid values are ANY and ACCESSIBLE. The default is ANY. Setting this to ACCESSIBLE returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions. When set to ANY permissions are not checked. |
cache-control | string | The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses. |
if-none-match | string | For querying if there is a cached value on the server. The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed. |
opc-request-id | string | Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
queryCompartmentSubtree | boolean | When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of accessLevel. Default is false. |
SELECT examples​
- get
Gets a virtual networking topology for the current region.
SELECT
entities,
limitedEntities,
relationships,
timeCreated,
type
FROM oci.network.networking_topologies
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND accessLevel = '{{ accessLevel }}'
AND queryCompartmentSubtree = '{{ queryCompartmentSubtree }}'
AND opc-request-id = '{{ opc-request-id }}'
AND if-none-match = '{{ if-none-match }}'
AND cache-control = '{{ cache-control }}'
;