Documentación de Oracle Cloud Infrastructure

Comandos de API de Rest

Lista de comandos de la API Rest para Resource Analytics.

Creación del recurso de instancia de Resource Analytics

Solicitud
Ruta: post /20241031/resourceAnalyticsInstances
Algo aquí
Campo Necesario Tipo de datos Notas
opc-retry-token No cadena Parámetro de cabecera
opc-request-id No cadena ID de solicitud de clientes para el rastreo.
compartmentId Sí cadena OCID del compartimento en el que se almacenará este recurso.
displayName No cadena Nombre fácil de recordar.
description No cadena Descripción definida por el usuario de este recurso.
freeformTags No Objeto Etiquetas de formato libre asociadas a este recurso, si las hay. Cada etiqueta es un par clave-valor simple sin ningún nombre, tipo o espacio de nombre predefinido.
definedTags No Objeto Las etiquetas definidas asociadas a este recurso, si las hay. Cada clave está predefinida y su ámbito es un espacio de nombres. Para obtener más información, consulte Etiquetas de recursos. Ejemplo: {"Operations": {"CostCenter": "42"}}
includedRegions Sí cadena[] Lista de ID de región desde los que se debe incluir la recopilación de datos. Por ejemplo, us-ashburn-1. Se necesita al menos una región.
adwAdminPassword Sí Object AdwAdminPasswordDetails (VaultSecretPasswordDetails or PlainTextPasswordDetails) Contraseña para el ADW que se va a crear en el arrendamiento de usuario. Puede ser un secreto de almacén o texto sin formato. Si la contraseña es de texto sin formato, debe tener entre 12 y 30 caracteres y contener al menos 1 letra mayúscula, 1 letra minúscula y 1 carácter numérico. No puede contener el símbolo de comillas dobles (") ni el nombre de usuario admin, independientemente de las mayúsculas/minúsculas.
VaultSecretPasswordDetails 
{
  "passwordType": "VAULT_SECRET", // required
  "secretId": "<ocid>", // required
}
PlainTextPasswordDetails 
{
  "passwordType": "PLAIN_TEXT", // required
  "password": "plain_text_password", // required
}
subnetId Sí cadena OCID de la subred a la que está asociado el recurso.
isMutualTlsRequired No Booleano Requiere TLS mutua (mTLS) al autenticar conexiones a la base de datos autónoma. El valor por defecto es falso.
isBringYourOwnLicense No Booleano Utilice la función Traiga su propia licencia (BYOL) al crear la instancia de ADW. El valor por defecto es false .
nsgIds No cadena[] Lista de grupos de seguridad de red.
Respuesta
Cabeceras
Algo aquí 2
Nombre Descripción
etag Para un control de simultaneidad optimista.
opc-request-id Identificador único para la solicitud.
opc-work-request-id OCID de la solicitud de trabajo.
Cuerpo
Vacío

Lista de recursos de instancia de Resource Analytics

Solicitud
Ruta: get /20241031/resourceAnalyticsInstances
Algo aquí
Campo Necesario Tipo de datos Notas
compartmentId Sí cadena ID del compartimento en el que se mostrarán los recursos.
page No cadena Token de página que representa la página en la que se van a empezar a recuperar resultados. Esto se recupera de una llamada de lista anterior.
limit No int El número máximo de elementos que se van a devolver.
lifecycleState No cadena Un filtro para devolver solo los recursos cuyo valor lifecycleState coincide con el valor lifecycleState especificado.
sortOrder No cadena Orden de clasificación que se va a utilizar, ya sea asc o desc.
sortBy No cadena Campo por el que se va a ordenar. Solo se puede proporcionar un orden de clasificación. El orden por defecto para timeCreated es descendente. El orden por defecto para displayName es ascendente. Si no se ha especificado ningún valor, timeCreated es el predeterminado.
opc-request-id No cadena (Cabecera) ID de solicitud del cliente para el rastreo.
Respuesta
Cabeceras
Algo aquí 2
Nombre Descripción
opc-request-id Identificador único para la solicitud.
opc-next-page Para la paginación de una lista de elementos.
Cuerpo
Matriz de 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": {},
}]

Obtención de recurso de instancia de Resource Analytics

Solicitud
Ruta: get /20241031/resourceAnalyticsInstances/<ocid>
Respuesta
Cabeceras
Algo aquí 2
Nombre Descripción
opc-request-id Identificador único para la solicitud.
Cuerpo
Devuelve 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": {},
}

Actualización de recurso de instancia de Resource Analytics

Solicitud
Ruta: put /20241031/resourceAnalyticsInstances/<ocid>
Algo aquí
Campo Necesario Tipo de datos Notas
opc-retry-token No cadena Parámetro de cabecera
page No cadena ID de solicitud de clientes para el rastreo.
limit No cadena Nombre fácil de recordar.
Descripción definida por el usuario de este recurso.
lifecycleState No Objeto Etiquetas de formato libre asociadas a este recurso, si las hay. Cada etiqueta es un par clave-valor simple sin ningún nombre, tipo o espacio de nombre predefinido.
sortOrder No Objeto Las etiquetas definidas asociadas a este recurso, si las hay. Cada clave está predefinida y su ámbito es un espacio de nombres. Para obtener más información, consulte Etiquetas de recurso. Por ejemplo: 
{"Operations": {"CostCenter": "42"}}
sortBy No cadena[] Lista de IDs de región de los que se va a incluir la recopilación de datos. Por ejemplo, us-ashburn-1. Se necesita al menos una región si se actualiza.

Una actualización sustituye todos los valores existentes.
Respuesta
Cabeceras
Algo aquí 2
Nombre Descripción
etag Para un control de simultaneidad optimista.
opc-request-id Identificador único para la solicitud.
opc-work-request-id OCID de la solicitud de trabajo.
Cuerpo
Vacío

Crear asociación de arrendamiento de instancia de Resource Analytics

Solicitud
Ruta: post /20241031/tenancyAttachments
Algo aquí
Campo Necesario Tipo de datos Notas
opc-retry-token No cadena Parámetro de cabecera
opc-request-id No cadena Parámetro de cabecera. ID de solicitud de clientes para el rastreo.
resourceAnalyticsInstanceId Sí cadena OCID de la instancia de análisis de recursos.
tenancyId Sí cadena OCID de arrendamiento.
description No cadena Una descripción del arrendamiento.
Respuesta
Cabeceras
Algo aquí 2
Nombre Descripción
etag Para un control de simultaneidad optimista.
opc-request-id Identificador único para la solicitud.
opc-work-request-id OCID de la solicitud de trabajo.
Cuerpo
Vacío

Lista de anexos de arrendamiento de instancia de Resource Analytics

Solicitud
Ruta: get /20241031/tenancyAttachments
Algo aquí
Campo Necesario Tipo de datos Notas
compartmentId Sí cadena ID del compartimento en el que se mostrarán los recursos.
page No cadena Token de página que representa la página en la que se van a empezar a recuperar resultados. Esto se recupera de una llamada de lista anterior.
limit No int El número máximo de elementos que se van a devolver.
lifecycleState No cadena Un filtro para devolver solo los recursos con su valor lifecycleState coincide con el valor lifecycleState proporcionado.
sortOrder No cadena Orden de clasificación que se va a utilizar, ya sea asc o desc.
sortBy No cadena Campo por el que se va a ordenar. Solo se puede proporcionar un orden de clasificación. El orden por defecto para timeCreated es descendente. El orden por defecto para displayName es ascendente. Si no se ha especificado ningún valor, timeCreated es el predeterminado.
opc-request-id No cadena Parámetro de cabecera. ID de solicitud de clientes para el rastreo.
Respuesta
Devuelve una matriz de objetos TenancyAttachmentSummary.
[{
  "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": {},
 }]

Obtener asociación de arrendamiento de instancia de Resource Analytics

Solicitud
Ruta: get /20241031/tenancyAttachments/<ocid>
Respuesta
Cabeceras
Algo aquí 2
Nombre Descripción
opc-request-id Identificador único para la solicitud.
Cuerpo
Devuelve la instancia tenancyAttachmentDetails
{
  "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": {},
 }

Colocar asociación de arrendamiento de instancia de Resource Analytics

Solicitud
Ruta: put /20241031/tenancyAttachments/<ocid>
Algo aquí 1
Campo Necesario Tipo de datos Descripción
description Sí cadena Una descripción del arrendamiento.
Cabeceras
Algo aquí 2
Nombre Descripción
opc-request-id Identificador único para la solicitud.
Respuesta
Cabeceras
Algo aquí 3
Nombre Descripción
etag Para un control de simultaneidad optimista.
opc-request-id Identificador único para la solicitud.
opc-work-request-id OCID de la solicitud de trabajo.
Cuerpo
Vacío

Suprimir asociación de arrendamiento de instancia de Resource Analytics

Solicitud
Ruta: delete /20241031/tenancyAttachments/<ocid>
Respuesta
Cabeceras
Algo aquí 3
Nombre Descripción
etag Para un control de simultaneidad optimista.
opc-request-id Identificador único para la solicitud.
opc-work-request-id OCID de la solicitud de trabajo.

Activar instancia de OAC en instancia de Resource Analytics

Solicitud
Ruta: post /20241031/analyticsWarehouses/<ocid>/actions/enableOac
Algo aquí
Campo Necesario Tipo de datos Descripción
opc-retry-token No cadena Parámetro de cabecera
opc-request-id No cadena Parámetro de cabecera. ID de solicitud de clientes para el rastreo.
resourceAnalyticsInstanceId Sí cadena OCID de la instancia de Resource Analytics.
attachmentType Sí enumeración El único valor posible es MANAGED.
attachmentDetails Sí Objeto Para OAC público
{
  "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>"]

  }
}
Respuesta
Cabeceras
Algo aquí 2
Nombre Descripción
etag Para un control de simultaneidad optimista.
opc-request-id Identificador único para la solicitud.
opc-work-request-id OCID de la solicitud de trabajo.
Cuerpo
Vacío

Desactivar instancia de OAC en instancia de Resource Analytics

Solicitud
Ruta: post /20241031/resourceAnalyticsInstances/<resourceAnalyticsInstanceId>/actions/disableOac
Algo aquí
Campo Necesario Tipo de datos Descripción
opc-retry-token No cadena Parámetro de cabecera
opc-request-id No cadena Parámetro de cabecera. ID de solicitud de clientes para el rastreo.
Respuesta
Cabeceras
Algo aquí 2
Nombre Descripción
etag Para un control de simultaneidad optimista.
opc-request-id Identificador único para la solicitud.
opc-work-request-id OCID de la solicitud de trabajo.
Cuerpo
Vacío