{ "opencollection": "1.0.0", "info": { "name": "Network Load Balancer API", "version": "20200501" }, "items": [ { "info": { "name": "networkLoadBalancer", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a list of all network load balancers in a compartment", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' (ascending) or 'desc' (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.\nThe default order for displayName is ascending. If no value is specified, then timeCreated is the default.\n" } ] }, "docs": "Returns a list of network load balancers.\n" }, { "info": { "name": "Creates a network load balancer.", "type": "http" }, "http": { "method": "POST", "url": "/20200501/networkLoadBalancers", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a network load balancer.\n" }, { "info": { "name": "List network load balancers health", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/health", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' (ascending) or 'desc' (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.\nThe default order for displayName is ascending. If no value is specified, then timeCreated is the default.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the summary health statuses for all network load balancers in the specified compartment." }, { "info": { "name": "Get network load balancer", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." } ] }, "docs": "Retrieves network load balancer configuration information by identifier." }, { "info": { "name": "Update the network load balancer identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the network load balancer" }, { "info": { "name": "Delete a provisioned network load balancer", "type": "http" }, "http": { "method": "DELETE", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." } ] }, "docs": "Deletes a network load balancer resource by identifier." }, { "info": { "name": "Change network load balancer compartment", "type": "http" }, "http": { "method": "POST", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a network load balancer into a different compartment within the same tenancy. For information about moving resources\nbetween compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "List backend sets", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' (ascending) or 'desc' (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.\nThe default order for displayName is ascending. If no value is specified, then timeCreated is the default.\n" } ] }, "docs": "Lists all backend sets associated with a given network load balancer." }, { "info": { "name": "Create backend set", "type": "http" }, "http": { "method": "POST", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a backend set to a network load balancer." }, { "info": { "name": "Get backend set", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set to retrieve.\n\nExample: `example_backend_set`\n" } ] }, "docs": "Retrieves the configuration information for the specified backend set." }, { "info": { "name": "Update backend set", "type": "http" }, "http": { "method": "PUT", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set to update.\n\nExample: `example_backend_set`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a backend set." }, { "info": { "name": "Delete backend set", "type": "http" }, "http": { "method": "DELETE", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set to delete.\n\nExample: `example_backend_set`\n" } ] }, "docs": "Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the network load balancer.\n\nBefore you can delete a backend set, you must remove it from any active listeners.\n" }, { "info": { "name": "List backends", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/backends", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' (ascending) or 'desc' (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.\nThe default order for displayName is ascending. If no value is specified, then timeCreated is the default.\n" }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set associated with the backend servers.\n\nExample: `example_backend_set`\n" } ] }, "docs": "Lists the backend servers for a given network load balancer and backend set." }, { "info": { "name": "Create backend", "type": "http" }, "http": { "method": "POST", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/backends", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set to which to add the backend server.\n\nExample: `example_backend_set`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a backend server to a backend set." }, { "info": { "name": "Get backend", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/backends/:backendName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set that includes the backend server.\n\nExample: `example_backend_set`\n" }, { "name": "backendName", "value": "", "type": "path", "description": "The name of the backend server to retrieve.\nIf the backend was created with an explicitly specified name, that name should be used here.\nIf the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :.\nIf the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :.\n\nExample: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080`\n" } ] }, "docs": "Retrieves the configuration information for the specified backend server." }, { "info": { "name": "Update backend", "type": "http" }, "http": { "method": "PUT", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/backends/:backendName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set associated with the backend server.\n\nExample: `example_backend_set`\n" }, { "name": "backendName", "value": "", "type": "path", "description": "The name of the backend server to update.\nIf the backend was created with an explicitly specified name, that name should be used here.\nIf the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :.\nIf the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :.\n\nExample: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a backend server within the specified backend set." }, { "info": { "name": "Delete backend", "type": "http" }, "http": { "method": "DELETE", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/backends/:backendName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set associated with the backend server.\n\nExample: `example_backend_set`\n" }, { "name": "backendName", "value": "", "type": "path", "description": "The name of the backend server to remove.\nIf the backend was created with an explicitly specified name, that name should be used here.\nIf the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :.\nIf the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :.\n\nExample: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080`\n" } ] }, "docs": "Removes a backend server from a given network load balancer and backend set." }, { "info": { "name": "Get backend health", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/backends/:backendName/health", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set associated with the backend server for which to retrieve the health status.\n\nExample: `example_backend_set`\n" }, { "name": "backendName", "value": "", "type": "path", "description": "The name of the backend server to retrieve health status for.\nIf the backend was created with an explicitly specified name, that name should be used here.\nIf the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :.\nIf the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :.\n\nExample: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080`\n" } ] }, "docs": "Retrieves the current health status of the specified backend server." }, { "info": { "name": "Get backend operational status", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/backends/:backendName/operationalStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set associated with the backend server for which to retrieve the operational status.\n\nExample: `example_backend_set`\n" }, { "name": "backendName", "value": "", "type": "path", "description": "The name of the backend server to retrieve health status for.\nIf the backend was created with an explicitly specified name, that name should be used here.\nIf the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :.\nIf the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :.\n\nExample: `10.0.0.3:8080` or `ocid1.privateip..oc1.<unique_ID>:8080`\n" } ] }, "docs": "Retrieves the current operational status of the specified backend server." }, { "info": { "name": "Get backend set health", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/health", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set for which to retrieve the health status.\n\nExample: `example_backend_set`\n" } ] }, "docs": "Retrieves the health status for the specified backend set." }, { "info": { "name": "Get health checker", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/healthChecker", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set associated with the health check policy to be retrieved.\n\nExample: `example_backend_set`\n" } ] }, "docs": "Retrieves the health check policy information for a given network load balancer and backend set." }, { "info": { "name": "Update health checker", "type": "http" }, "http": { "method": "PUT", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/backendSets/:backendSetName/healthChecker", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set associated with the health check policy to be retrieved.\n\nExample: `example_backend_set`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the health check policy for a given network load balancer and backend set." }, { "info": { "name": "Get network load balancer health", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/health", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." } ] }, "docs": "Retrieves the health status for the specified network load balancer." }, { "info": { "name": "List Listeners", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/listeners", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' (ascending) or 'desc' (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.\nThe default order for displayName is ascending. If no value is specified, then timeCreated is the default.\n" } ] }, "docs": "Lists all listeners associated with a given network load balancer." }, { "info": { "name": "Create Listener", "type": "http" }, "http": { "method": "POST", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/listeners", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a listener to a network load balancer." }, { "info": { "name": "Get listener", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/listeners/:listenerName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "listenerName", "value": "", "type": "path", "description": "The name of the listener to get.\n\nExample: `example_listener`\n" } ] }, "docs": "Retrieves listener properties associated with a given network load balancer and listener name." }, { "info": { "name": "Update listener", "type": "http" }, "http": { "method": "PUT", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/listeners/:listenerName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "listenerName", "value": "", "type": "path", "description": "The name of the listener to update.\n\nExample: `example_listener`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a listener for a given network load balancer." }, { "info": { "name": "Delete listener", "type": "http" }, "http": { "method": "DELETE", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/listeners/:listenerName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." }, { "name": "listenerName", "value": "", "type": "path", "description": "The name of the listener to delete.\n\nExample: `example_listener`\n" } ] }, "docs": "Deletes a listener from a network load balancer." }, { "info": { "name": "Update Network Security Groups", "type": "http" }, "http": { "method": "PUT", "url": "/20200501/networkLoadBalancers/:networkLoadBalancerId/networkSecurityGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "networkLoadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the network load balancer to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the network security groups associated with the specified network load balancer." }, { "info": { "name": "List policies", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancersPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' (ascending) or 'desc' (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.\nThe default order for displayName is ascending. If no value is specified, then timeCreated is the default.\n" } ] }, "docs": "Lists the available network load balancer policies." }, { "info": { "name": "List protocols", "type": "http" }, "http": { "method": "GET", "url": "/20200501/networkLoadBalancersProtocols", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' (ascending) or 'desc' (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.\nThe default order for displayName is ascending. If no value is specified, then timeCreated is the default.\n" } ] }, "docs": "This API has been deprecated so it won't return the updated list of supported protocls.\nLists all supported traffic protocols.\n" }, { "info": { "name": "List workrequests", "type": "http" }, "http": { "method": "GET", "url": "/20200501/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists all work requests." }, { "info": { "name": "Get workrequest status", "type": "http" }, "http": { "method": "GET", "url": "/20200501/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The identifier of the asynchronous request." } ] }, "docs": "Retrieves the details of the work request with the given identifier." }, { "info": { "name": "Lists workrequest errors", "type": "http" }, "http": { "method": "GET", "url": "/20200501/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The identifier of the asynchronous request." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists workrequest logs", "type": "http" }, "http": { "method": "GET", "url": "/20200501/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The identifier of the asynchronous request." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page from which to start retrieving results.\nFor list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Returns a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }