(required) ID of the dashboard that is being moved.
if_match
(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.
opc_retry_token
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
CHANGE_MANAGEMENT_SAVED_SEARCHES_COMPARTMENT Function 🔗
Moves the saved search from the existing compartment to a new compartment.
(required) ID of the saved search that is being moved.
if_match
(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.
opc_retry_token
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
CREATE_MANAGEMENT_DASHBOARD Function 🔗
Creates a new dashboard. Limit for number of saved searches in a dashboard is 20. Here's an example of how you can use CLI to create a dashboard. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: `oci management-dashboard dashboard get --management-dashboard-id \"ocid1.managementdashboard.oc1..dashboardId1\" --query data > Create.json.` You can then modify the Create.json file by removing the `id` attribute and making other required changes, and use the `oci management-dashboard dashboard create` command.
(required) JSON metadata for creating a new dashboard.
opc_retry_token
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
CREATE_MANAGEMENT_SAVED_SEARCH Function 🔗
Creates a new saved search. Here's an example of how you can use CLI to create a saved search. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: `oci management-dashboard saved-search get --management-saved-search-id ocid1.managementsavedsearch.oc1..savedsearchId1 --query data > Create.json`. You can then modify the Create.json file by removing the `id` attribute and making other required changes, and use the `oci management-dashboard saved-search create` command.
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
EXPORT_DASHBOARD Function 🔗
Exports an array of dashboards and their saved searches. Export is designed to work with importDashboard. Here's an example of how you can use CLI to export a dashboard: `$oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > dashboards.json`
(required) List of dashboardIds in plain text. The syntax is '{\"dashboardIds\":[\"dashboardId1\", \"dashboardId2\", ...]}'. Escaping is needed when using in OCI CLI. For example, \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" .
opc_retry_token
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
GET_MANAGEMENT_DASHBOARD Function 🔗
Gets a dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile's state property.
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
IMPORT_DASHBOARD Function 🔗
Imports an array of dashboards and their saved searches. Here's an example of how you can use CLI to import a dashboard. For information on the details that must be passed to IMPORT, you can use the EXPORT API to obtain the Import.json file: `oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > Import.json`. Note that import API updates the resource if it already exists, and creates a new resource if it does not exist. To import to a different compartment, edit and change the compartmentId to the desired compartment OCID. Here's an example of how you can use CLI to import: `oci management-dashboard dashboard import --from-json file://Import.json`
(required) JSON metadata for importing dashboards and their saved searches.
if_match
(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.
opc_retry_token
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
LIST_MANAGEMENT_DASHBOARDS Function 🔗
Gets the list of dashboards in a compartment with pagination. Returned properties are the summary.
(required) The ID of the compartment in which to list resources.
display_name
(optional) A filter to return only resources that match the entire display name given.
opc_request_id
(optional) The client request ID for tracing.
limit
(optional) The maximum number of items to return.
page
(optional) The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call.
sort_order
(optional) The sort order to use, either 'asc' or 'desc'.
Allowed values are: 'ASC', 'DESC'
sort_by
(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. If no value is specified timeCreated is the default.
Allowed values are: 'timeCreated', 'displayName'
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
LIST_MANAGEMENT_SAVED_SEARCHES Function 🔗
Gets the list of saved searches in a compartment with pagination. Returned properties are the summary.
(required) The ID of the compartment in which to list resources.
display_name
(optional) A filter to return only resources that match the entire display name given.
opc_request_id
(optional) The client request ID for tracing.
limit
(optional) The maximum number of items to return.
page
(optional) The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call.
sort_order
(optional) The sort order to use, either 'asc' or 'desc'.
Allowed values are: 'ASC', 'DESC'
sort_by
(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. If no value is specified timeCreated is the default.
Allowed values are: 'timeCreated', 'displayName'
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
UPDATE_MANAGEMENT_DASHBOARD Function 🔗
Updates an existing dashboard identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API. Limit for number of saved searches in a dashboard is 20.
(required) JSON metadata for changed dashboard properties.
if_match
(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.
opc_retry_token
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
UPDATE_MANAGEMENT_SAVED_SEARCH Function 🔗
Updates an existing saved search identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API.
(required) JSON metadata for changed saved search properties.
if_match
(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.
opc_retry_token
(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.
opc_request_id
(optional) The client request ID for tracing.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://managementdashboard.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.