Get Virtual Network VCN topology
GET {{baseUrl}}/vcnTopology?compartmentId={{compartment_ocid}}&accessLevel=ANY&queryCompartmentSubtree=true&vcnId=amet ut
Gets a virtual network topology for a given VCN.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment. | |
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.
|
| 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.
|
| vcnId | string | | (Required) The OCID of the VCN. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | string | Unique identifier for the request. | |
| If you need to contact Oracle about a particular request, please provide the request ID. | |||
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. | |||
cache-control | string | The Cache-Control HTTP header holds directives (instructions) | |
| for caching in both requests and responses. | |||
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"entities":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"relationships":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vcnId":"est"}