{ "opencollection": "1.0.0", "info": { "name": "Load Balancing Load Balancer API", "version": "20170115" }, "items": [ { "info": { "name": "loadBalancer", "type": "folder" }, "items": [ { "info": { "name": "ListLoadBalancerHealths", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancerHealths", "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\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For 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\nExample: `3`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to return health status information for." } ] }, "docs": "Lists the summary health statuses for all load balancers in the specified compartment." }, { "info": { "name": "ListPolicies", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancerPolicies", "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 load balancer policies to list." }, { "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\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For 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\nExample: `3`\n" } ] }, "docs": "Lists the available load balancer policies." }, { "info": { "name": "ListProtocols", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancerProtocols", "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 load balancer protocols to list." }, { "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\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For 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\nExample: `3`\n" } ] }, "docs": "Lists all supported traffic protocols." }, { "info": { "name": "ListShapes", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancerShapes", "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 load balancer shapes to list." }, { "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\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For 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\nExample: `3`\n" } ] }, "docs": "Lists the valid load balancer shapes." }, { "info": { "name": "GetWorkRequest", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancerWorkRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the work request to retrieve." } ] }, "docs": "Gets the details of a work request." }, { "info": { "name": "ListLoadBalancers", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers", "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\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For 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\nExample: `3`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to list." }, { "name": "detail", "value": "", "type": "query", "description": "The level of detail to return for each result. Can be `full` or `simple`.\n\nExample: `full`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending.\nDefault order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n\nExample: `example_load_balancer`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state.\n\nExample: `SUCCEEDED`\n" } ] }, "docs": "Lists all load balancers in the specified compartment." }, { "info": { "name": "CreateLoadBalancer", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new load balancer in the specified compartment. For general information about load balancers,\nsee [Overview of the Load Balancing Service](/Content/Balance/Concepts/balanceoverview.htm).\n\nFor the purposes of access control, you must provide the OCID of the compartment where you want\nthe load balancer to reside. Notice that the load balancer doesn't have to be in the same compartment as the VCN\nor backend set. If you're not sure which compartment to use, put the load balancer in the sam" }, { "info": { "name": "GetLoadBalancer", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to retrieve." } ] }, "docs": "Gets the specified load balancer's configuration information." }, { "info": { "name": "UpdateLoadBalancer", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a load balancer's configuration." }, { "info": { "name": "DeleteLoadBalancer", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to delete." } ] }, "docs": "Stops a load balancer and removes it from service." }, { "info": { "name": "ListBackendSets", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend sets to retrieve." } ] }, "docs": "Lists all backend sets associated with a given load balancer." }, { "info": { "name": "CreateBackendSet", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a backend set." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a backend set to a load balancer." }, { "info": { "name": "GetBackendSet", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set to retrieve.\n\nExample: `example_backend_set`\n" } ] }, "docs": "Gets the specified backend set's configuration information." }, { "info": { "name": "UpdateBackendSet", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set." }, { "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": "DeleteBackendSet", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set." }, { "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 load balancer.\n\nBefore you can delete a backend set, you must remove it from any active listeners.\n" }, { "info": { "name": "ListBackends", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/backends", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers." }, { "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 load balancer and backend set." }, { "info": { "name": "CreateBackend", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/backends", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set to add the backend server to.\n\nExample: `example_backend_set`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a backend server to a backend set." }, { "info": { "name": "GetBackend", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/backends/:backendName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server." }, { "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 IP address and port of the backend server to retrieve.\n\nExample: `10.0.0.3:8080`\n" } ] }, "docs": "Gets the specified backend server's configuration information." }, { "info": { "name": "UpdateBackend", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/backends/:backendName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server." }, { "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 IP address and port of the backend server to update.\n\nExample: `10.0.0.3:8080`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a backend server within the specified backend set." }, { "info": { "name": "DeleteBackend", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/backends/:backendName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server." }, { "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 IP address and port of the backend server to remove.\n\nExample: `10.0.0.3:8080`\n" } ] }, "docs": "Removes a backend server from a given load balancer and backend set." }, { "info": { "name": "BackendHealth", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/backends/:backendName/health", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend server health status to be retrieved." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set associated with the backend server to retrieve the health status for.\n\nExample: `example_backend_set`\n" }, { "name": "backendName", "value": "", "type": "path", "description": "The IP address and port of the backend server to retrieve the health status for.\n\nExample: `10.0.0.3:8080`\n" } ] }, "docs": "Gets the current health status of the specified backend server." }, { "info": { "name": "BackendSetHealth", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/health", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set health status to be retrieved." }, { "name": "backendSetName", "value": "", "type": "path", "description": "The name of the backend set to retrieve the health status for.\n\nExample: `example_backend_set`\n" } ] }, "docs": "Gets the health status for the specified backend set." }, { "info": { "name": "GetHealthChecker", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/healthChecker", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be retrieved." }, { "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": "Gets the health check policy information for a given load balancer and backend set." }, { "info": { "name": "UpdateHealthChecker", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/backendSets/:backendSetName/healthChecker", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the health check policy to be updated." }, { "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 load balancer and backend set." }, { "info": { "name": "ListCertificates", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/certificates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundles\nto be listed.\n" } ] }, "docs": "Lists all SSL certificates bundles associated with a given load balancer." }, { "info": { "name": "CreateCertificate", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/certificates", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add the certificate bundle." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an asynchronous request to add an SSL certificate bundle." }, { "info": { "name": "DeleteCertificate", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/certificates/:certificateName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundle\nto be deleted.\n" }, { "name": "certificateName", "value": "", "type": "path", "description": "The name of the certificate bundle to delete.\n\nExample: `example_certificate_bundle`\n" } ] }, "docs": "Deletes an SSL certificate bundle from a load balancer." }, { "info": { "name": "ChangeLoadBalancerCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer to move." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a 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": "LoadBalancerHealth", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/health", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to return health status for." } ] }, "docs": "Gets the health status for the specified load balancer." }, { "info": { "name": "ListHostnames", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/hostnames", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostnames\nto retrieve.\n" } ] }, "docs": "Lists all hostname resources associated with the specified load balancer." }, { "info": { "name": "CreateHostname", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/hostnames", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the hostname to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a hostname resource to the specified load balancer. For more information, see\n[Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm).\n" }, { "info": { "name": "GetHostname", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/hostnames/:name", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." }, { "name": "name", "value": "", "type": "path", "description": "The name of the hostname resource to retrieve.\n\nExample: `example_hostname_001`\n" } ] }, "docs": "Gets the specified hostname resource's configuration information." }, { "info": { "name": "UpdateHostname", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/hostnames/:name", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the virtual hostname\nto update.\n" }, { "name": "name", "value": "", "type": "path", "description": "The name of the hostname resource to update.\n\nExample: `example_hostname_001`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a\nvirtual hostname.\n" }, { "info": { "name": "DeleteHostname", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/hostnames/:name", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostname to delete." }, { "name": "name", "value": "", "type": "path", "description": "The name of the hostname resource to delete.\n\nExample: `example_hostname_001`\n" } ] }, "docs": "Deletes a hostname resource from the specified load balancer.\n" }, { "info": { "name": "CreateListener", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/listeners", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer on which to add a listener." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a listener to a load balancer." }, { "info": { "name": "UpdateListener", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/listeners/:listenerName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener 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 load balancer." }, { "info": { "name": "DeleteListener", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/listeners/:listenerName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener to delete." }, { "name": "listenerName", "value": "", "type": "path", "description": "The name of the listener to delete.\n\nExample: `example_listener`\n" } ] }, "docs": "Deletes a listener from a load balancer." }, { "info": { "name": "ListListenerRules", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/listeners/:listenerName/rules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the listener." }, { "name": "listenerName", "value": "", "type": "path", "description": "The name of the listener the rules are associated with.\nExample: `example_listener`\n" } ] }, "docs": "Lists all of the rules from all of the rule sets associated with the specified listener. The response organizes\nthe rules in the following order:\n\n* Access control rules\n* Allow method rules\n* Request header rules\n* Response header rules\n" }, { "info": { "name": "UpdateNetworkSecurityGroups", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/networkSecurityGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to update the NSGs for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the network security groups associated with the specified load balancer." }, { "info": { "name": "ListPathRouteSets", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/pathRouteSets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route sets\nto retrieve.\n" } ] }, "docs": "Lists all path route sets associated with the specified load balancer." }, { "info": { "name": "CreatePathRouteSet", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/pathRouteSets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the path route set to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a path route set to a load balancer. For more information, see\n[Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm).\n" }, { "info": { "name": "GetPathRouteSet", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/pathRouteSets/:pathRouteSetName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." }, { "name": "pathRouteSetName", "value": "", "type": "path", "description": "The name of the path route set to retrieve.\n\nExample: `example_path_route_set`\n" } ] }, "docs": "Gets the specified path route set's configuration information." }, { "info": { "name": "UpdatePathRouteSet", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/pathRouteSets/:pathRouteSetName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to update." }, { "name": "pathRouteSetName", "value": "", "type": "path", "description": "The name of the path route set to update.\n\nExample: `example_path_route_set`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter\npath route rules in a path route set.\n\nTo add a new path route rule to a path route set, the `pathRoutes` in the\n[UpdatePathRouteSetDetails](#/en/loadbalancer/20170115/requests/UpdatePathRouteSetDetails) object must include\nboth the new path route rule to add and the existing path route rules to retain.\n" }, { "info": { "name": "DeletePathRouteSet", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/pathRouteSets/:pathRouteSetName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route set to delete." }, { "name": "pathRouteSetName", "value": "", "type": "path", "description": "The name of the path route set to delete.\n\nExample: `example_path_route_set`\n" } ] }, "docs": "Deletes a path route set from the specified load balancer.\n\nTo delete a path route rule from a path route set, use the\n[UpdatePathRouteSet](#/en/loadbalancer/20170115/PathRouteSet/UpdatePathRouteSet) operation.\n" }, { "info": { "name": "ListRoutingPolicies", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/routingPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policies.\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\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For 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\nExample: `3`\n" } ] }, "docs": "Lists all routing policies associated with the specified load balancer." }, { "info": { "name": "CreateRoutingPolicy", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/routingPolicies", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to add the routing policy rule list to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a routing policy to a load balancer. For more information, see\n[Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm).\n" }, { "info": { "name": "GetRoutingPolicy", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/routingPolicies/:routingPolicyName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." }, { "name": "routingPolicyName", "value": "", "type": "path", "description": "The name of the routing policy to retrieve.\n\nExample: `example_routing_policy`\n" } ] }, "docs": "Gets the specified routing policy." }, { "info": { "name": "UpdateRoutingPolicy", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/routingPolicies/:routingPolicyName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policy to update." }, { "name": "routingPolicyName", "value": "", "type": "path", "description": "The name of the routing policy to update.\n\nExample: `example_routing_policy_name`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Overwrites an existing routing policy on the specified load balancer. Use this operation to add, delete, or alter\nrouting policy rules in a routing policy.\n\nTo add a new routing rule to a routing policy, the body must include both the new routing rule to add and the existing rules to retain.\n" }, { "info": { "name": "DeleteRoutingPolicy", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/routingPolicies/:routingPolicyName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policy to delete." }, { "name": "routingPolicyName", "value": "", "type": "path", "description": "The name of the routing policy to delete.\n\nExample: `example_routing_policy`\n" } ] }, "docs": "Deletes a routing policy from the specified load balancer.\n\nTo delete a routing rule from a routing policy, use the\n[UpdateRoutingPolicy](#/en/loadbalancer/20170115/RoutingPolicies/UpdateRoutingPolicy) operation.\n" }, { "info": { "name": "ListRuleSets", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/ruleSets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." } ] }, "docs": "Lists all rule sets associated with the specified load balancer." }, { "info": { "name": "CreateRuleSet", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/ruleSets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new rule set associated with the specified load balancer. For more information, see\n[Managing Rule Sets](/Content/Balance/Tasks/managingrulesets.htm).\n" }, { "info": { "name": "GetRuleSet", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/ruleSets/:ruleSetName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." }, { "name": "ruleSetName", "value": "", "type": "path", "description": "The name of the rule set to retrieve.\n\nExample: `example_rule_set`\n" } ] }, "docs": "Gets the specified set of rules." }, { "info": { "name": "UpdateRuleSet", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/ruleSets/:ruleSetName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." }, { "name": "ruleSetName", "value": "", "type": "path", "description": "The name of the rule set to update.\n\nExample: `example_rule_set`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter\nthe rules in a rule set.\n\nTo add a new rule to a set, the body must include both the new rule to add and the existing rules to retain.\n" }, { "info": { "name": "DeleteRuleSet", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/ruleSets/:ruleSetName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer." }, { "name": "ruleSetName", "value": "", "type": "path", "description": "The name of the rule set to delete.\n\nExample: `example_rule_set`\n" } ] }, "docs": "Deletes a rule set from the specified load balancer.\n\nTo delete a rule from a rule set, use the\n[UpdateRuleSet](#/en/loadbalancer/20170115/RuleSet/UpdateRuleSet) operation.\n" }, { "info": { "name": "ListSSLCipherSuites", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/sslCipherSuites", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the associated load balancer.\n" } ] }, "docs": "Lists all SSL cipher suites associated with the specified load balancer." }, { "info": { "name": "CreateSSLCipherSuite", "type": "http" }, "http": { "method": "POST", "url": "/20170115/loadBalancers/:loadBalancerId/sslCipherSuites", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the associated load balancer.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a custom SSL cipher suite." }, { "info": { "name": "GetSSLCipherSuite", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/sslCipherSuites/:name", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the associated load balancer.\n" }, { "name": "name", "value": "", "type": "path", "description": "The name of the SSL cipher suite to retrieve.\n\nexample: `example_cipher_suite`\n" } ] }, "docs": "Gets the specified SSL cipher suite's configuration information." }, { "info": { "name": "UpdateSSLCipherSuite", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/sslCipherSuites/:name", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the associated load balancer.\n" }, { "name": "name", "value": "", "type": "path", "description": "The name of the SSL cipher suite to update.\n\nexample: `example_cipher_suite`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing SSL cipher suite for the specified load balancer." }, { "info": { "name": "DeleteSSLCipherSuite", "type": "http" }, "http": { "method": "DELETE", "url": "/20170115/loadBalancers/:loadBalancerId/sslCipherSuites/:name", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the associated load balancer.\n" }, { "name": "name", "value": "", "type": "path", "description": "The name of the SSL cipher suite to delete.\n\nexample: `example_cipher_suite`\n" } ] }, "docs": "Deletes an SSL cipher suite from a load balancer." }, { "info": { "name": "UpdateLoadBalancerShape", "type": "http" }, "http": { "method": "PUT", "url": "/20170115/loadBalancers/:loadBalancerId/updateShape", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the load balancer whose shape will be updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the\nLB. The service will try to perform this operation in the least disruptive way to existing connections, but\nthere is a possibility that they might be lost during the LB resizing process. The new shape becomes effective\nas soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will\nstart accepting larger bandwidth and when reshaping to a sma" }, { "info": { "name": "ListWorkRequests", "type": "http" }, "http": { "method": "GET", "url": "/20170115/loadBalancers/:loadBalancerId/workRequests", "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\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For 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\nExample: `3`\n" }, { "name": "loadBalancerId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the work requests to retrieve." } ] }, "docs": "Lists the work requests for a given load balancer." } ] } ], "bundled": true }