Oracle Cloud Infrastructure Documentation

Rest API Commands

List of the Rest API commands for Resource Analytics.

Resource Analytics Instance Resource Creation

Request
Path: ​post /20241031/resourceAnalyticsInstances
Something here
Field Required Data Type Notes
opc-retry-token No string Header parameter
opc-request-id No string The client request ID for tracing.
compartmentId Yes string The OCID of the compartment to store this resource in.
displayName No string A user-friendly name.
description No string A user-defined description of this resource.
freeformTags No Object The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace.
definedTags No Object The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.Example: {"Operations": {"CostCenter": "42"}}
includedRegions Yes string[] List of region IDs to include data collection from. For example, us-ashburn-1. At least one region is required.
adwAdminPassword Yes Object AdwAdminPasswordDetails (VaultSecretPasswordDetails or PlainTextPasswordDetails) Password for the ADW to be created in User Tenancy. Can either be a vault secret or plain text. If plain text, the password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It can't contain the double quote symbol (") or the username admin, regardless of casing.
VaultSecretPasswordDetails 
{
  "passwordType": "VAULT_SECRET", // required
  "secretId": "<ocid>", // required
}
PlainTextPasswordDetails 
{
  "passwordType": "PLAIN_TEXT", // required
  "password": "plain_text_password", // required
}
subnetId Yes string The OCID of the subnet the resource is associated with.
isMutualTlsRequired No Boolean Require mutual TLS (mTLS) when authenticating connections to the Autonomous database. Default is false.
isBringYourOwnLicense No Boolean Use the Bring Your Own License (BYOL) feature when creating the ADW instance. Default is false .
nsgIds No string[] List of network security groups.
Response
Headers
Something here 2
Name Description
etag For optimistic concurrency control.
opc-request-id Unique identifier for the request.
opc-work-request-id The OCID of the work request.
Body
Empty

Resource Analytics Instance Resource List

Request
Path: ​get /20241031/resourceAnalyticsInstances
Something here
Field Required Data Type Notes
compartmentId Yes string The ID of the compartment in which to list resources.
page No string The page token representing the page at which to start retrieving results. This is retrieved from a previous list call.
limit No int The maximum number of items to return.
lifecycleState No string A filter to return only resources their lifecycleState matches the specified lifecycleState.
sortOrder No string The sort order to use, either asc or desc.
sortBy No string The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, timeCreated is the default.
opc-request-id No string (Header) The client request ID for tracing.
Response
Headers
Something here 2
Name Description
opc-request-id Unique identifier for the request.
opc-next-page For pagination of a list of items.
Body
Array of ResourceAnalyticsInstanceSummary 
[{
  "id" : "ocid1.TBD.oc1.phx.<unique_ID>",
  "compartmentId": "ocid1.tenancy.oc1..<unique_ID>",
  "displayName" : "my little warehouse",
  "description": "Home region tenancy"
  "lifecycleState" : "PROVISIONING",
  "lifecycleDetails": "string",
  "timeCreated" : "timestamp",
  "timeUpdated" : "timestamp",
  "freeformTags": {},
  "definedTags": {},
  "systemTags": {},
}]

Resource Analytics Instance Resource Get

Request
Path: ​get /20241031/resourceAnalyticsInstances/<ocid>
Response
Headers
Something here 2
Name Description
opc-request-id Unique identifier for the request.
Body
Returns ResourceAnalyticsInstance 
{
  "id": "ocid1.TBD.oc1.phx.<unique_ID>", 
  "compartmentId": <ocid from resourceAnalyticsInstance>,
  "displayName": "my little warehouse",
  "description": "Warehouse covers our top tenancies",
  "includedRegions": [
    "string"
  ],
  "adwId": "OCID",
  "adwName": "generated name",
  "oacId": "OCID",
  "oacName": "generated name",
  "lifecycleState": "ACTIVE",
  "lifecycleDetails": "string",
  "timeCreated": "timestamp",
  "timeUpdated": "timestamp",
  "freeformTags": {},
  "definedTags": {},
  "systemTags": {},
}

Resource Analytics Instance Resource Update

Request
Path: ​put /20241031/resourceAnalyticsInstances/<ocid>
Something here
Field Required Data Type Notes
opc-retry-token No string Header parameter
page No string The client request ID for tracing.
limit No string A user-friendly name.
A user-defined description of this resource.
lifecycleState No Object The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace.
sortOrder No Object The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. For example: 
{"Operations": {"CostCenter": "42"}}
sortBy No string[] The list of region IDs to include data collection from. For example, us-ashburn-1. At least one region is required if updating.

An update replaces all existing values.
Response
Headers
Something here 2
Name Description
etag For optimistic concurrency control.
opc-request-id Unique identifier for the request.
opc-work-request-id The OCID of the work request.
Body
Empty

Create Resource Analytics Instance Tenancy Attachment

Request
Path: ​post /20241031/tenancyAttachments
Something here
Field Required Data Type Notes
opc-retry-token No string Header parameter
opc-request-id No string Header parameter. The client request ID for tracing.
resourceAnalyticsInstanceId Yes string The OCID of the resource analytics instance.
tenancyId Yes string The Tenancy OCID.
description No string A description of the tenancy.
Response
Headers
Something here 2
Name Description
etag For optimistic concurrency control.
opc-request-id Unique identifier for the request.
opc-work-request-id The OCID of the work request.
Body
Empty

Resource Analytics Instance Tenancy Attachment List

Request
Path: ​get /20241031/tenancyAttachments
Something here
Field Required Data Type Notes
compartmentId Yes string The ID of the compartment in which to list resources.
page No string The page token representing the page at which to start retrieving results. This is retrieved from a previous list call.
limit No int The maximum number of items to return.
lifecycleState No string A filter to return only resources their lifecycleState matches the given lifecycleState.
sortOrder No string The sort order to use, either asc or desc.
sortBy No string The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, timeCreated is the default.
opc-request-id No string Header parameter. The client request ID for tracing.
Response
Returns an array of TenancyAttachmentSummary objects.
[{
  "id": <ocid>,
  "description": "Tenancy used for internal business",
  "resourceAnalyticsInstanceId": <ocid>,
  "compartmentId": <ocid>,
  "tenancyId": <ocid>,
  "isReportingTenancy": boolean,
  "timeCreated" : "timestamp",
  "timeUpdated" : "timestamp",
  "lifecycleState": "PROVISIONING",
  "lifecycleDetails": "string",
  "systemTags": {},
 }]

Get Resource Analytics Instance Tenancy Attachment

Request
Path: ​get /20241031/tenancyAttachments/<ocid>
Response
Headers
Something here 2
Name Description
opc-request-id Unique identifier for the request.
Body
Returns tenancyAttachmentDetails instance
{
  "id": <ocid>,
  "description": "Tenancy used for internal business",
  "resourceAnalyticsInstanceId": <ocid>,
  "compartmentId": <ocid>,
  "tenancyId": <ocid>,
  "isReportingTenancy": boolean,
  "timeCreated" : "timestamp",
  "timeUpdated" : "timestamp",
  "lifecycleState": "PROVISIONING",
  "lifecycleDetails": "string",
  "systemTags": {},
 }

Put Resource Analytics Instance Tenancy Attachment

Request
Path: ​put /20241031/tenancyAttachments/<ocid>
Something here 1
Field Required Data Type Description
description Yes string A description of the tenancy.
Headers
Something here 2
Name Description
opc-request-id Unique identifier for the request.
Response
Headers
Something here 3
Name Description
etag For optimistic concurrency control.
opc-request-id Unique identifier for the request.
opc-work-request-id The OCID of the work request.
Body
Empty

Delete Resource Analytics Instance Tenancy Attachment

Request
Path: ​delete /20241031/tenancyAttachments/<ocid>
Response
Headers
Something here 3
Name Description
etag For optimistic concurrency control.
opc-request-id Unique identifier for the request.
opc-work-request-id The OCID of the work request.

Enable OAC Instance on Resource Analytics Instance

Request
Path: ​post /20241031/analyticsWarehouses/<ocid>/actions/enableOac
Something here
Field Required Data Type Description
opc-retry-token No string Header parameter
opc-request-id No string Header parameter. The client request ID for tracing.
resourceAnalyticsInstanceId Yes string The OCID of the Resource Analytics instance.
attachmentType Yes enum The only possible value is MANAGED.
attachmentDetails Yes Object For public OAC
{
  "idcsDomainId": "<ocid>", // required
  "isBringYourOwnLicense": boolean, // optional, default false
}
For Private OAC

{
  "idcsDomainId": "<ocid>", // required
  "isBringYourOwnLicense": boolean, // optional, default false
  "networkDetails": {
     "subnetId": "<ocid>", // required
     "nsgIds": ["<ocid>", "<ocid>"]

  }
}
Response
Headers
Something here 2
Name Description
etag For optimistic concurrency control.
opc-request-id Unique identifier for the request.
opc-work-request-id The OCID of the work request.
Body
Empty

Disable OAC Instance on Resource Analytics Instance

Request
Path: ​post /20241031/resourceAnalyticsInstances/<resourceAnalyticsInstanceId>/actions/disableOac
Something here
Field Required Data Type Description
opc-retry-token No string Header parameter
opc-request-id No string Header parameter. The client request ID for tracing.
Response
Headers
Something here 2
Name Description
etag For optimistic concurrency control.
opc-request-id Unique identifier for the request.
opc-work-request-id The OCID of the work request.
Body
Empty