Service Mesh Functions
Package: DBMS_CLOUD_OCI_SVM_SERVICE_MESH
CANCEL_WORK_REQUEST Function
Cancels the work request with the given ID.
Syntax
FUNCTION cancel_work_request (
work_request_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_cancel_work_request_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_ACCESS_POLICY_COMPARTMENT Function
Moves an AccessPolicy resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_access_policy_compartment (
access_policy_id varchar2,
change_access_policy_compartment_details dbms_cloud_oci_service_mesh_change_access_policy_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_change_access_policy_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique AccessPolicy identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_INGRESS_GATEWAY_COMPARTMENT Function
Moves a IngressGateway resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_ingress_gateway_compartment (
ingress_gateway_id varchar2,
change_ingress_gateway_compartment_details dbms_cloud_oci_service_mesh_change_ingress_gateway_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_change_ingress_gateway_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique IngressGateway identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_INGRESS_GATEWAY_ROUTE_TABLE_COMPARTMENT Function
Moves a IngressGatewayRouteTable resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_ingress_gateway_route_table_compartment (
ingress_gateway_route_table_id varchar2,
change_ingress_gateway_route_table_compartment_details dbms_cloud_oci_service_mesh_change_ingress_gateway_route_table_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_change_ingress_gateway_route_table_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique IngressGatewayRouteTable identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_MESH_COMPARTMENT Function
Moves a Mesh resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_mesh_compartment (
mesh_id varchar2,
change_mesh_compartment_details dbms_cloud_oci_service_mesh_change_mesh_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_change_mesh_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Mesh identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_VIRTUAL_DEPLOYMENT_COMPARTMENT Function
Moves a VirtualDeployment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_virtual_deployment_compartment (
virtual_deployment_id varchar2,
change_virtual_deployment_compartment_details dbms_cloud_oci_service_mesh_change_virtual_deployment_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_change_virtual_deployment_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualDeployment identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_VIRTUAL_SERVICE_COMPARTMENT Function
Moves a VirtualService resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_virtual_service_compartment (
virtual_service_id varchar2,
change_virtual_service_compartment_details dbms_cloud_oci_service_mesh_change_virtual_service_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_change_virtual_service_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualService identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_VIRTUAL_SERVICE_ROUTE_TABLE_COMPARTMENT Function
Moves a VirtualServiceRouteTable resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Syntax
FUNCTION change_virtual_service_route_table_compartment (
virtual_service_route_table_id varchar2,
change_virtual_service_route_table_compartment_details dbms_cloud_oci_service_mesh_change_virtual_service_route_table_compartment_details_t,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_change_virtual_service_route_table_compartment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualServiceRouteTable identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_ACCESS_POLICY Function
Creates a new AccessPolicy.
Syntax
FUNCTION create_access_policy (
create_access_policy_details dbms_cloud_oci_service_mesh_create_access_policy_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_create_access_policy_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new AccessPolicy. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_INGRESS_GATEWAY Function
Creates a new IngressGateway.
Syntax
FUNCTION create_ingress_gateway (
create_ingress_gateway_details dbms_cloud_oci_service_mesh_create_ingress_gateway_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_create_ingress_gateway_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new IngressGateway. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_INGRESS_GATEWAY_ROUTE_TABLE Function
Creates a new IngressGatewayRouteTable.
Syntax
FUNCTION create_ingress_gateway_route_table (
create_ingress_gateway_route_table_details dbms_cloud_oci_service_mesh_create_ingress_gateway_route_table_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_create_ingress_gateway_route_table_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new IngressGatewayRouteTable. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_MESH Function
Creates a new Mesh.
Syntax
FUNCTION create_mesh (
create_mesh_details dbms_cloud_oci_service_mesh_create_mesh_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_create_mesh_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new Mesh. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_VIRTUAL_DEPLOYMENT Function
Creates a new VirtualDeployment.
Syntax
FUNCTION create_virtual_deployment (
create_virtual_deployment_details dbms_cloud_oci_service_mesh_create_virtual_deployment_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_create_virtual_deployment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new VirtualDeployment. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_VIRTUAL_SERVICE Function
Creates a new VirtualService.
Syntax
FUNCTION create_virtual_service (
create_virtual_service_details dbms_cloud_oci_service_mesh_create_virtual_service_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_create_virtual_service_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new VirtualService. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_VIRTUAL_SERVICE_ROUTE_TABLE Function
Creates a new VirtualServiceRouteTable.
Syntax
FUNCTION create_virtual_service_route_table (
create_virtual_service_route_table_details dbms_cloud_oci_service_mesh_create_virtual_service_route_table_details_t,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_create_virtual_service_route_table_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Details for the new VirtualServiceRouteTable. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_ACCESS_POLICY Function
Deletes an AccessPolicy resource by identifier.
Syntax
FUNCTION delete_access_policy (
access_policy_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_delete_access_policy_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique AccessPolicy identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_INGRESS_GATEWAY Function
Deletes an IngressGateway resource by identifier.
Syntax
FUNCTION delete_ingress_gateway (
ingress_gateway_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_delete_ingress_gateway_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique IngressGateway identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_INGRESS_GATEWAY_ROUTE_TABLE Function
Deletes a IngressGatewayRouteTable resource by identifier.
Syntax
FUNCTION delete_ingress_gateway_route_table (
ingress_gateway_route_table_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_delete_ingress_gateway_route_table_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique IngressGatewayRouteTable identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_MESH Function
Deletes a Mesh resource by identifier.
Syntax
FUNCTION delete_mesh (
mesh_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_delete_mesh_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Mesh identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_VIRTUAL_DEPLOYMENT Function
Deletes a VirtualDeployment resource by identifier.
Syntax
FUNCTION delete_virtual_deployment (
virtual_deployment_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_delete_virtual_deployment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualDeployment identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_VIRTUAL_SERVICE Function
Deletes a VirtualService resource by identifier
Syntax
FUNCTION delete_virtual_service (
virtual_service_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_delete_virtual_service_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualService identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_VIRTUAL_SERVICE_ROUTE_TABLE Function
Deletes a VirtualServiceRouteTable resource by identifier.
Syntax
FUNCTION delete_virtual_service_route_table (
virtual_service_route_table_id varchar2,
if_match varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_delete_virtual_service_route_table_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualServiceRouteTable identifier. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_ACCESS_POLICY Function
Get an AccessPolicy by identifier.
Syntax
FUNCTION get_access_policy (
access_policy_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_access_policy_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique AccessPolicy identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_INGRESS_GATEWAY Function
Gets an IngressGateway by identifier.
Syntax
FUNCTION get_ingress_gateway (
ingress_gateway_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_ingress_gateway_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique IngressGateway identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_INGRESS_GATEWAY_ROUTE_TABLE Function
Gets a IngressGatewayRouteTable by identifier.
Syntax
FUNCTION get_ingress_gateway_route_table (
ingress_gateway_route_table_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_ingress_gateway_route_table_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique IngressGatewayRouteTable identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MESH Function
Gets a Mesh by identifier.
Syntax
FUNCTION get_mesh (
mesh_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_mesh_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Mesh identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_PROXY_DETAILS Function
Returns the attributes of the Proxy such as proxy image version.
Syntax
FUNCTION get_proxy_details (
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_proxy_details_response_t;
Parameters
Parameter | Description |
---|---|
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_VIRTUAL_DEPLOYMENT Function
Gets a VirtualDeployment by identifier.
Syntax
FUNCTION get_virtual_deployment (
virtual_deployment_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_virtual_deployment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualDeployment identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_VIRTUAL_SERVICE Function
Gets a VirtualService by identifier.
Syntax
FUNCTION get_virtual_service (
virtual_service_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_virtual_service_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualService identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_VIRTUAL_SERVICE_ROUTE_TABLE Function
Gets a VirtualServiceRouteTable by identifier.
Syntax
FUNCTION get_virtual_service_route_table (
virtual_service_route_table_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_virtual_service_route_table_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualServiceRouteTable identifier. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_WORK_REQUEST Function
Gets the status of the work request with the given ID.
Syntax
FUNCTION get_work_request (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_get_work_request_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_ACCESS_POLICIES Function
Returns a list of AccessPolicy objects.
Syntax
FUNCTION list_access_policies (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
mesh_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_access_policies_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources that match the entire name given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeCreated' is descending. Default order for 'name' is ascending. Allowed values are: 'id', 'timeCreated', 'name' |
|
(optional) The client request ID for tracing. |
|
(optional) Unique Mesh identifier. |
|
(optional) Unique AccessPolicy identifier. |
|
(optional) A filter to return only resources that match the life cycle state given. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_INGRESS_GATEWAY_ROUTE_TABLES Function
Returns a list of IngressGatewayRouteTable objects.
Syntax
FUNCTION list_ingress_gateway_route_tables (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
ingress_gateway_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_ingress_gateway_route_tables_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources that match the entire name given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeCreated' is descending. Default order for 'name' is ascending. Allowed values are: 'id', 'timeCreated', 'name' |
|
(optional) The client request ID for tracing. |
|
(optional) Unique IngressGateway identifier. |
|
(optional) Unique IngressGatewayRouteTable identifier. |
|
(optional) A filter to return only resources that match the life cycle state given. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_INGRESS_GATEWAYS Function
Returns a list of IngressGateway objects.
Syntax
FUNCTION list_ingress_gateways (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
mesh_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_ingress_gateways_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources that match the entire name given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeCreated' is descending. Default order for 'name' is ascending. Allowed values are: 'id', 'timeCreated', 'name' |
|
(optional) The client request ID for tracing. |
|
(optional) Unique Mesh identifier. |
|
(optional) Unique IngressGateway identifier. |
|
(optional) A filter to return only resources that match the life cycle state given. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_MESHES Function
Returns a list of Mesh objects.
Syntax
FUNCTION list_meshes (
compartment_id varchar2,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_meshes_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources that match the entire displayName given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: 'id', 'timeCreated', 'displayName' |
|
(optional) The client request ID for tracing. |
|
(optional) A filter to return only resources that match the life cycle state given. |
|
(optional) Unique Mesh identifier. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_VIRTUAL_DEPLOYMENTS Function
Returns a list of VirtualDeployments.
Syntax
FUNCTION list_virtual_deployments (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
virtual_service_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_virtual_deployments_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources that match the entire name given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeCreated' is descending. Default order for 'name' is ascending. Allowed values are: 'id', 'timeCreated', 'name' |
|
(optional) The client request ID for tracing. |
|
(optional) Unique VirtualService identifier. |
|
(optional) Unique VirtualDeployment identifier. |
|
(optional) A filter to return only resources that match the life cycle state given. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_VIRTUAL_SERVICE_ROUTE_TABLES Function
Returns a list of VirtualServiceRouteTable objects.
Syntax
FUNCTION list_virtual_service_route_tables (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
virtual_service_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_virtual_service_route_tables_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources that match the entire name given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeCreated' is descending. Default order for 'name' is ascending. Allowed values are: 'id', 'timeCreated', 'name' |
|
(optional) The client request ID for tracing. |
|
(optional) Unique VirtualService identifier. |
|
(optional) Unique VirtualServiceRouteTable identifier. |
|
(optional) A filter to return only resources that match the life cycle state given. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_VIRTUAL_SERVICES Function
Returns a list of VirtualService objects.
Syntax
FUNCTION list_virtual_services (
compartment_id varchar2,
name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
mesh_id varchar2 DEFAULT NULL,
id varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_virtual_services_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) A filter to return only resources that match the entire name given. |
|
(optional) The maximum number of items to return. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for 'timeCreated' is descending. Default order for 'name' is ascending. Allowed values are: 'id', 'timeCreated', 'name' |
|
(optional) The client request ID for tracing. |
|
(optional) Unique Mesh identifier. |
|
(optional) Unique VirtualService identifier. |
|
(optional) A filter to return only resources that match the life cycle state given. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUEST_ERRORS Function
Return a (paginated) list of errors for a given work request.
Syntax
FUNCTION list_work_request_errors (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_work_request_errors_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: 'timestamp' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUEST_LOGS Function
Return a (paginated) list of logs for a given work request.
Syntax
FUNCTION list_work_request_logs (
work_request_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_work_request_logs_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the asynchronous request. |
|
(optional) The client request ID for tracing. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: 'timestamp' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_WORK_REQUESTS Function
Lists the work requests in a compartment.
Syntax
FUNCTION list_work_requests (
compartment_id varchar2,
work_request_id varchar2 DEFAULT NULL,
resource_id varchar2 DEFAULT NULL,
operation_status varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_list_work_requests_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) The ID of the compartment in which to list resources. |
|
(optional) The ID of the asynchronous work request. |
|
(optional) A filter to return work requests that match the given resourceId. |
|
(optional) A filter to return only resources that match the operation status given. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'WAITING', 'NEEDS_ATTENTION', 'CANCELING', 'CANCELED' |
|
(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: 'timeAccepted' |
|
(optional) The client request ID for tracing. |
|
(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. |
|
(optional) The maximum number of items to return. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_ACCESS_POLICY Function
Updates the AccessPolicy.
Syntax
FUNCTION update_access_policy (
access_policy_id varchar2,
update_access_policy_details dbms_cloud_oci_service_mesh_update_access_policy_details_t,
if_match varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_update_access_policy_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique AccessPolicy identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_INGRESS_GATEWAY Function
Updates the IngressGateway.
Syntax
FUNCTION update_ingress_gateway (
ingress_gateway_id varchar2,
update_ingress_gateway_details dbms_cloud_oci_service_mesh_update_ingress_gateway_details_t,
if_match varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_update_ingress_gateway_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique IngressGateway identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_INGRESS_GATEWAY_ROUTE_TABLE Function
Updates the IngressGatewayRouteTable.
Syntax
FUNCTION update_ingress_gateway_route_table (
ingress_gateway_route_table_id varchar2,
update_ingress_gateway_route_table_details dbms_cloud_oci_service_mesh_update_ingress_gateway_route_table_details_t,
if_match varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_update_ingress_gateway_route_table_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique IngressGatewayRouteTable identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_MESH Function
Updates the Mesh.
Syntax
FUNCTION update_mesh (
mesh_id varchar2,
update_mesh_details dbms_cloud_oci_service_mesh_update_mesh_details_t,
if_match varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_update_mesh_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique Mesh identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_VIRTUAL_DEPLOYMENT Function
Updates the VirtualDeployment.
Syntax
FUNCTION update_virtual_deployment (
virtual_deployment_id varchar2,
update_virtual_deployment_details dbms_cloud_oci_service_mesh_update_virtual_deployment_details_t,
if_match varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_update_virtual_deployment_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualDeployment identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_VIRTUAL_SERVICE Function
Updates the VirtualService.
Syntax
FUNCTION update_virtual_service (
virtual_service_id varchar2,
update_virtual_service_details dbms_cloud_oci_service_mesh_update_virtual_service_details_t,
if_match varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_update_virtual_service_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualService identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_VIRTUAL_SERVICE_ROUTE_TABLE Function
Updates the VirtualServiceRouteTable.
Syntax
FUNCTION update_virtual_service_route_table (
virtual_service_route_table_id varchar2,
update_virtual_service_route_table_details dbms_cloud_oci_service_mesh_update_virtual_service_route_table_details_t,
if_match varchar2 DEFAULT NULL,
opc_retry_token varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_svm_service_mesh_update_virtual_service_route_table_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Unique VirtualServiceRouteTable identifier. |
|
(required) The information to be updated. |
|
(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
|
(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
|
(optional) The client request ID for tracing. |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://servicemesh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |