Oracle Cloud Infrastructure Documentation

Administer Services

Typical Workflow to Administer a Service

After you create an Oracle Analytics Cloud instance with Oracle Cloud Infrastructure for the first time, follow these tasks as a guide.

Task Description More Information
View and update service details View instances, edit details, move your instance to a different compartment, and more.

Use the search facility to find instances across compartments.

View or Update a Service using the Console

Find Oracle Analytics Cloud Resources

Scale a service up or down

Increase or decrease the number of Oracle Compute Units (OCPUs) allocated to your service.

Scale a Service

Pause or resume a service

Pause a service to temporarily prevent users from accessing the service.

Pause and Resume a Service

Delete a service

Delete services that you don’t want anymore.

Delete a Service

Monitor services Monitor the status of your service. Monitor a Service
Track usage and billing Track usage and costs asociated with your services.

Read Usage Reports

Analyze Usage Costs for Oracle Analytics Cloud

Review Audit Logs for Oracle Analytics Cloud

View or Update a Service

You can access services and update instance details using the Console, API, or command line. You can edit details such as the description, license type, or tags.

Note

Required IAM Policy

Verb: inspect (to view), manage (to update)

Resource Types: analytics-instance, analytics-instances

Permission: ANALYTICS_INSTANCE_INSPECT (to view), ANALYTICS_INSTANCE_UPDATE (to update)

See About Permissions to Manage Oracle Analytics Cloud Instances.

View or Update a Service using the Console

You can use Oracle Cloud Infrastructure Console to view and edit Oracle Analytics Cloud instances.

  1. Sign in to your Oracle Cloud account.
  2. In Console, click Navigation menuin the top left corner.
  3. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  4. Select the compartment that contains the Oracle Analytics Cloud instances you're looking for.
  5. If required, filter the list by State or Feature Set to find the instance you want.
  6. To change the description or the license type, click Tasks menu for the instance, and select Update.
  7. To edit or add tags, click the name of your instance to show the details page, and then click Tags or Add Tags.

View or Update a Service using the REST API

You use the GetAnalyticsInstance and UpdateAnalyticsInstance operations to return and edit Oracle Analytics Cloud instances. If you want to move the instance to a different container you use ChangeAnalyticsInstanceCompartment.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use these operations:

View or Update a Service using the Command Line

You can use the analytics-instance list, analytics-instance get, analytics-instance update, and analytics-instance change-compartmentcommands to return and update Oracle Analytics Cloud instances.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use these commands:

Scale a Service

You can scale the number of Oracle Compute Units (OCPUs) that your service uses as your needs change.

Note

Required IAM Policy

Verb: manage

Resource Types: analytics-instance, analytics-instances

Custom Permission: ANALYTICS_INSTANCE_MANAGE

See About Permissions to Manage Oracle Analytics Cloud Instances.

About Scaling

If you subscribe to Oracle Analytics Cloud through Universal Credits and your service performs poorly, you can scale up the number of Oracle Compute Units (OCPUs) allocated to the service to improve performance. To save costs or if your workload is reduced, you might scale down.

You can scale services up and down within the OCPU range available to your service (see table) and within the overall service limit for your tenancy (see Service Limits). Users don't experience any downtime when you scale a service up or down; your service stays up and running.

  • Scale the Number of OCPUs

    With Universal Credits, you can either scale between 2 and 8 OCPUs or between 10 and 12 OCPUs. If you want to scale across these ranges (for example, scale up from 8 to 12 OCPUs or scale down from 12 to 6 OCPUs), you must create a service instance with the OCPUs that you want and migrate your content to the new service.

    Current OCPUs OCPU Range Scale Up within Range? Scale Down within Range?
    (Incremental + increase) (Incremental - decrease)
    1 1 No (not applicable for trials) No (not applicable for trials)
    2 2 - 8 Yes (+2, +4, +6) No (minimum for this range)
    4 2 - 8 Yes (+2, +4) Yes (-2)
    6 2 - 8 Yes (+2) Yes (-2, -4)
    8 2 - 8 No (maximum for this range) Yes (-2, -4, -6)
    10 10 - 12 Yes (+2) No (minimum for this range)
    12 10 - 12 No (maximum for this range) Yes (-2)
    16 16 No No
    24 24 No No
    36 36 No No
    52 52 No No
Note

Scale options aren't available for trial services (1 OCPU). At the end of your trial, you must create a new instance with the OCPUs that you want (minimum 2 OCPU). If you want to keep the content that you created in the trial service, you can save it to a snapshot and copy it to the new service.

Scale Up or Down using the Console

You can use the Console to scale up or scale down the number of OCPUs allocated to your service.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to scale.
  5. Note how many OCPUs your service currently uses.

    The current Capacity is displayed on the Instance Information tab.

  6. Click Scale Up/Down.

    You can't scale up or down while your service is being backed up, restored, or undergoing similar administrative operations. If you see the message System is not in a READY state. Current state is CONFIGURING, wait a few minutes for the current operation to complete and try again.

  7. Select the number of OCPUs you want.

    The values available to you depend on how many OCPUs your service currently uses. Remember, you can add or remove OCPUs only within the OCPU range of your service (see table).

    You see a message if scale options aren't available for your environment. For example, you can't scale a trial instance.

  8. Click Scale Up/Down to confirm.

    The scale up (or down) operation takes a few minutes to complete. While in progress, the status of the service changes to Updating.

Scale Up or Down using the REST API

You can use the ScaleAnalyticsInstance operation to scale up or scale down an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Scale Up or Down using the Command Line

You can use the analytics-instance scale command to scale up or scale down an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Pause and Resume a Service

When you subscribe to Oracle Analytics Cloud through Universal Credits, you can pause a service if you want to temporarily prevent anyone accessing the service. You can pause and resume an Oracle Analytics Cloud instance using the Console, API, or command line.

Note

Required IAM Policy

Verb: use

Resource Types: analytics-instance, analytics-instances

Permission: ANALYTICS_INSTANCE_USE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Pause and Resume using the Console

You can use the Console to pause a service if you want to temporarily prevent anyone accessing the service.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  4. Click the name of the instance you want to pause or resume.
  5. To temporarily pause a service, click Stop.

    While in progress, the status of the service changes to Updating.

    After a few minutes, the service status changes to Inactive.

  6. To resume the service, click Start.

    While in progress, the status of the service changes to Updating.

    After a few minutes, the service status changes to Active.

    When complete, users can sign in to the service and billing resumes.

Pause and Resume a Service using the REST API

You use the StopAnalyticsInstance and StartAnalyticsInstance operations to pause and resume an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use these operations:

Pause and Resume using the Command Line

You can use the analytics-instance stop and analytics-instance start commands to pause and resume an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use these commands:

Delete a Service

You can delete an Oracle Analytics Cloud instance using the Console, API, or command line.

Note

Required IAM Policy

Verb: manage

Resource Types: analytics-instance, analytics-instances

Permission: ANALYTICS_INSTANCE_DELETE

See About Permissions to Manage Oracle Analytics Cloud Instances.

Delete a Service using the Console

You can use the Console to delete services you created but don't need anymore.

  1. In Oracle Analytics Cloud, take a snapshot of your content and download the snapshot to your local system in case you want to restore the content in the future.
  2. In Oracle Cloud Infrastructure Console, click Navigation menuin the top left corner.
  3. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  4. Select the compartment that contains the Oracle Analytics Cloud instance you're looking for.
  5. Click Tasks menu for the instance you want to delete, and then select Delete.
  6. Click Delete Instance to confirm.
The Status of the instance changes to Deleting. After a few moments, the status changes to Deleted.

Delete a Service using the REST API

You can use the DeleteAnalyticsInstance operation to delete an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use this operation:

Delete a Service using the Command Line

You can use the analytics-instance delete command to delete an Oracle Analytics Cloud instance.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Monitor a Service

You can monitor the current status and progress of operations for an Oracle Analytics Cloud instance using the Console, API, or command line.

Note

Required IAM Policy

Verb: read

Resource Types: analytics-instance, analytics-instances

Permission: ANALYTICS_INSTANCE_READ

See About Permissions to Manage Oracle Analytics Cloud Instances.

Monitor Status using the Console

You can use Oracle Cloud Infrastructure Console to check the status of your Oracle Analytics Cloud instances and any operations that are in progress.

  1. In Console, click Navigation menuin the top left corner.
  2. Under Solutions and Platform, select Analytics, then Analytics Cloud.
  3. Select the compartment that contains the Oracle Analytics Cloud instances you're looking for.
    A list of all the instances in the compartment are displayed.
  4. Check the Status column to determine the current status of your instance.
    • Creating: Instance is in the process of being created.
    • Active: Instance is running normally.
    • Updating: Instance is being updated. For example, in the process of scaling up or down.
    • Inactive: Instance has been temporarily stopped or is stopping.
    • Failed: Instance isn't running due to an error.
    • Deleting: Instance is in the process of being deleted.
    • Deleted: Instance has been deleted and resources released.
  5. Click the name of your service to access the activity details.
    Use the Activity Log section to track the history and status of activities related to the instance. For example, work requests such as create, start, stop, scale, and so on.
    • ACCEPTED: The request is in the queue to be processed.
    • IN PROGRESS: The work request started but isn't complete.
    • SUCCEEDED: A work request record exists for this request and an associated WORK_COMPLETED record is in the state SUCCEEDED.
    • FAILED: A work request record exists for this request and an associated WORK_COMPLETED record is in the state FAILED.
    • CANCELING: The work request is in the process of canceling.
    • CANCELED: The work request has been canceled.

Monitor Status using the REST API

You use GetWorkRequest to get the current status of operations you perform on Oracle Analytics Cloud instances. If you want to cancel an operation, you use DeleteWorkRequest. To check errors and access logs, you use ListWorkRequestErrors and ListWorkRequestLogs.

Refer to the Oracle Cloud Infrastructure REST API Reference for information about how to use these operations:

Monitor Status using the Command Line

You use the work-request list and work-request get commands to get the current status of operations you perform on Oracle Analytics Cloud instances. If you want to cancel an operation, you use work-request delete. To check errors and access logs, you use work-request-error list and work-request-log list.

Refer to the Oracle Cloud Infrastructure CLI Command Reference for information about how to use this command:

Find Oracle Analytics Cloud Resources

You can use the simple and advanced search features in Oracle Cloud Infrastructure Console to find Oracle Analytics Cloud instances across compartments in your tenancy.

Simple Search

If you know the name of the resource you're looking for, enter all or part of the name in the search bar. For example, myanalytics.
Results matching your search display. If you don't find what you're looking for, or you want to perform more sophisticated searches, click the Advanced Search button.

Advanced Search

You can enter advanced search queries to search for Oracle Analytics Cloud instances. Click Advanced Search, then either select one of the predefined, sample queries or enter one of your own.

Advanced search query

For example:

  • To find all the Oracle Analytics Cloud instances in your tenancy:

    query
      analyticsinstance resources
  • To find all the Oracle Analytics Cloud instances that are tagged with the term "test":

    query
      analyticsinstance resources
        where
          (freeformTags.key = 'Environment'&& freeformTags.value = 'test')
  • To find all the Oracle Analytics Cloud instances that are currently up and running normally (active):

    query
      analyticsinstance resources
        where lifeCycleState = 'ACTIVE'

To learn more, see Overview of Search.

Read Usage Reports

A usage report is a comma-separated value (CSV) file that gives you a detailed breakdown of Oracle Analytics Cloud resources in Oracle Cloud Infrastructure, for audit or invoice reconciliation. You must be assigned to a security policies that allows you to read usage reports.

For example, if you have a federated Oracle Identity Cloud Service user group called OCI_Analytics_Admins mapped to an OCI user group called AnalyticsServiceAdmins, you might want to allow this group to read usage reports.

The policy statement will look like this:

define tenancy usage-report as ocid1.tenancy.oc1..aaaaaaaaned4fkpkisbwjlr56u7cj63lf3wffbilvqknstgtvzub7vhqkggq
endorse group AnalyticsServiceAdmins to read objects in tenancy usage-report

To learn more, see Usage Reports Overview and Accessing Usage Reports.

Analyze Usage Costs for Oracle Analytics Cloud

You can analyze the cost of the Oracle Analytics Cloud instances that you're using in the Cost Analysis page.

The way you're billed for a particular instance depends which edition you subscribe to (Professional or Enterprise) and whether you have an Oracle Cloud subscription or a Bring Your Own License (BYOL) subscription:

  • Oracle Analytics Cloud - Professional - OCPU Per Hour
  • Oracle Analytics Cloud - Professional - BYOL - OCPU Per Hour
  • Oracle Analytics Cloud - Enterprise - OCPU Per Hour
  • Oracle Analytics Cloud - Enterprise - BYOL - OCPU Per Hour
To open the Cost Analysis Page, navigate to Account Management, and click Cost Analysis. Expand the Analytics section to view your costs for Oracle Analytics Cloud.

You must be assigned to a security policy that allows you to read cost information. For example, if you have a federated Oracle Identity Cloud Service user group called OCI_Analytics_Admins mapped to an OCI user group called AnalyticsServiceAdmins, you might want to allow this group to see cost information.

The policy statement will look like this:

allow group AnalyticsServiceAdmins to read usage-reports

To learn more, see Checking Your Balance and Usage.

Review Audit Logs for Oracle Analytics Cloud

Oracle Cloud Infrastructure logs API operations on Oracle Analytics Cloud instances for audit purposes.

You can view the audit logs for these Oracle Analytics Cloud operations from the Audit page:

  • ListAnalyticsInstances
  • CreateAnalyticsInstance
  • GetAnalyticsInstance
  • UpdateAnalyticsInstance
  • DeleteAnalyticsInstance
  • StartAnalyticsInstance
  • StopAnalyticsInstance
  • ScaleAnalyticsInstance
  • ChangeAnalyticsInstanceCompartment
  • ListWorkRequests
  • GetWorkRequest
  • DeleteWorkRequest
  • ListWorkRequestErrors
  • ListWorkRequestLogs
To open the Audit page, navigate to Governance, click Audit, and select the compartment you want. You can filter the log to audit a particular Oracle Analytics Cloud operation, such as StopAnalyticsInstance, by entering the name of the operation in the Keyword field. You can also filter by date or API operation (POST, DELETE, PUT, and so on).

You must be assigned to a security policy that allows you to read audit events. For example, if you have a federated Oracle Identity Cloud Service user group called OCI_Analytics_Admins mapped to an OCI user group called AnalyticsServiceAdmins, you might want to allow this group to view audit logs for the whole tenancy or for a particular compartment.

For example, a policy statement that look something like this:

allow group AnalyticsServiceAdmins to read audit-events in tenancy
allow group AnalyticsServiceAdmins to read audit-events in compartment MyEnterpriseAnalytics

To learn more, see Overview of Audit.