{ "opencollection": "1.0.0", "info": { "name": "Oracle Multicloud Omhub Network Anchor API", "version": "20180828" }, "items": [ { "info": { "name": "omhubNetworkAnchor", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of NetworkAnchors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/networkAnchors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud base compartment or sub-compartment in which to list resources.\nA Multicloud base compartment is an OCI compartment that maps to a subscription in a cloud service provider (such as Azure or AWS).\n" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources." }, { "name": "subscriptionServiceName", "value": "", "type": "query", "description": "The cloud service provider." }, { "name": "networkAnchorLifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "externalLocation", "value": "", "type": "query", "description": "The cloud service provider region." }, { "name": "networkAnchorOciSubnetId", "value": "", "type": "query", "description": "A filter to return only NetworkAnchor resources that match the given OCI subnet Id." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, a list operation will return NetworkAnchors from all child compartments in the provided compartmentId parameter." }, { "name": "networkAnchorOciVcnId", "value": "", "type": "query", "description": "A filter to return only NetworkAnchor resources that match the given OCI Vcn Id." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the NetworkAnchor." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "shouldFetchVcnName", "value": "", "type": "query", "description": "Whether to fetch and include the vcn display name, which may introduce additional latency." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\nIn general, the sort order is `DESC` when sorting by time and `ASC` otherwise.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" } ] }, "docs": "Lists network anchors in the specified Multicloud subscription, Multicloud compartment, and partner cloud region.\nDetails listed for each resource include name, state, VCN, and ODB network ID.\nFor more information, see\n[Listing Network Anchors](/iaas/Content/multicloud-hub/list-network-anchors.htm).\n" }, { "info": { "name": "Get NetworkAnchor.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/networkAnchors/:networkAnchorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkAnchorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the NetworkAnchor." }, { "name": "subscriptionServiceName", "value": "", "type": "query", "description": "The cloud service provider." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources." }, { "name": "externalLocation", "value": "", "type": "query", "description": "The cloud service provider region." }, { "name": "shouldFetchVcnName", "value": "", "type": "query", "description": "Whether to fetch and include the vcn display name, which may introduce additional latency." } ] }, "docs": "Gets details for the specified network anchor. The subscription OCID and service name are required.\nFor more information, see\n[Getting a Network Anchor's Details](/iaas/Content/multicloud-hub/get-network-anchor.htm).\n" } ] } ], "bundled": true }