{ "opencollection": "1.0.0", "info": { "name": "Data Infrastructure Cloud@Customer Service Datainfracc API", "version": "20251101" }, "items": [ { "info": { "name": "datainfracc", "type": "folder" }, "items": [ { "info": { "name": "Obtain a list of Data Infrastructures.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/infrastructures", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.\nFor list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided,\nit will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the entire display name given. The match is case sensitive." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return resources that match the specified lifecycle state." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order that you want to use, which is either `ASC` or `DESC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which you want to sort. You can provide only one type of sort order. The default order for `timeCreated` is descending. The default order for `displayName` is ascending. If no value is specified, then `timeCreated` is the default.\nWhen listing software images within the same `version`, using `sortBy=buildIdentifier` is recommended. `buildIdentifier` is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.\n" } ] }, "docs": "Obtain a list of Data Infrastructures.\n" }, { "info": { "name": "Create a Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/infrastructures", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Data Infrastructure using the specified details.\n" }, { "info": { "name": "Obtain the Data Infrastructure.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ] }, "docs": "Obtain the Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Update the Data Infrastructure.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Delete the Data Infrastructure.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." }, { "name": "isForceDeleteInfrastructure", "value": "", "type": "query", "description": "When set to `true`, infrastructure will be deleted even if it has dependent resources. \nIf set to `false`, deletion will fail if the infrastructure has dependent resources.\nDefault is `false`.\n" } ] }, "docs": "Delete the Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm). It must be called once the resource usage is complete.\n" }, { "info": { "name": "Activate Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId/actions/activate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate an Data Infrastructure using the specified details.\n" }, { "info": { "name": "Change the compartment for the specified Data Infrastructure Cloud@Customer.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the Data Infrastructure Cloud@Customer Compartment to the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Downloads the configuration file for the specified Data Infrastructure Cloud@Customer.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId/actions/downloadConfigFile", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ] }, "docs": "Downloads the configuration file for the specified Data Infrastructure Cloud@Customer." }, { "info": { "name": "Downloads the validation script for the specified Data Infrastructure Cloud@Customer.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId/actions/downloadValidationScript", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ] }, "docs": "Downloads the validation script for the specified Data Infrastructure Cloud@Customer." }, { "info": { "name": "Scale storage for the given infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId/actions/scaleStorage", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Scale storage for the specified infrastructure using the specified details.\n" }, { "info": { "name": "Validate Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId/actions/validate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate an Data Infrastructure using the specified details.\n" }, { "info": { "name": "Get the available scale options for the infrastructure.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/infrastructures/:infrastructureId/scaleOptions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "infrastructureId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." } ] }, "docs": "Get the available scale options for the infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Obtain a list of maintenance executions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/maintenanceExecutions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.\nFor list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided,\nit will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the entire display name given. The match is case sensitive." }, { "name": "infrastructureId", "value": "", "type": "query", "description": "The Data Infrastructure ID." }, { "name": "maintenanceRunId", "value": "", "type": "query", "description": "The maintenance run OCID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle states." }, { "name": "maintenanceRunType", "value": "", "type": "query", "description": "The sub-type of the maintenance run." }, { "name": "timeAcceptedLessThanOrEqualTo", "value": "", "type": "query", "description": "Filter maintenance run for before given time." }, { "name": "timeAcceptedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Filter maintenance run for after given time." }, { "name": "type", "value": "", "type": "query", "description": "The maintenance execution type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which you want to sort. You can provide only one type of sort order. The default order for `timeCreated` is descending. The default order for `displayName` is ascending. If no value is specified, then `timeCreated` is the default.\nWhen listing software images within the same `version`, using `sortBy=buildIdentifier` is recommended. `buildIdentifier` is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order that you want to use, which is either `ASC` or `DESC`." } ] }, "docs": "Gets a list of the maintenance executions in the specified compartment.\n" }, { "info": { "name": "Obtain the maintenance execution.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/maintenanceExecutions/:maintenanceExecutionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maintenanceExecutionId", "value": "", "type": "path", "description": "The maintenance execution OCID." } ] }, "docs": "Gets information about the specified [OCID](/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "Obtain a list of maintenance runs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/maintenanceRuns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.\nFor list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided,\nit will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the entire display name given. The match is case sensitive." }, { "name": "infrastructureId", "value": "", "type": "query", "description": "The Data Infrastructure ID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle states." }, { "name": "maintenanceRunType", "value": "", "type": "query", "description": "The sub-type of the maintenance run." }, { "name": "timeAcceptedLessThanOrEqualTo", "value": "", "type": "query", "description": "Filter maintenance run for before given time." }, { "name": "timeAcceptedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Filter maintenance run for after given time." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which you want to sort. You can provide only one type of sort order. The default order for `timeCreated` is descending. The default order for `displayName` is ascending. If no value is specified, then `timeCreated` is the default.\nWhen listing software images within the same `version`, using `sortBy=buildIdentifier` is recommended. `buildIdentifier` is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order that you want to use, which is either `ASC` or `DESC`." } ] }, "docs": "Gets a list of the maintenance runs in the specified compartment.\n" }, { "info": { "name": "Obtain the maintenance run.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/maintenanceRuns/:maintenanceRunId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maintenanceRunId", "value": "", "type": "path", "description": "The maintenance run OCID." } ] }, "docs": "Gets information about the specified [OCID](/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "Update maintenance run attributes.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251101/maintenanceRuns/:maintenanceRunId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "maintenanceRunId", "value": "", "type": "path", "description": "The maintenance run OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update maintenance run attributes.\n" }, { "info": { "name": "Reschedule a maintenance run.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/maintenanceRuns/:maintenanceRunId/actions/reschedule", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "maintenanceRunId", "value": "", "type": "path", "description": "The maintenance run OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reschedules the specified maintenance run by providing a new `timeScheduled` value.\nOnly maintenance runs in SCHEDULED state may be rescheduled.\n" }, { "info": { "name": "Obtain a list of VM cluster networks on Data Infrastructure.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/vmClusterNetworks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.\nFor list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided,\nit will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the entire display name given. The match is case sensitive." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return resources that match the specified lifecycle state." }, { "name": "isScanEnabled", "value": "", "type": "query", "description": "A filter to return VM cluster network resources that matches the specified value." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order that you want to use, which is either `ASC` or `DESC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which you want to sort. You can provide only one type of sort order. The default order for `timeCreated` is descending. The default order for `displayName` is ascending. If no value is specified, then `timeCreated` is the default.\nWhen listing software images within the same `version`, using `sortBy=buildIdentifier` is recommended. `buildIdentifier` is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.\n" }, { "name": "infrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." }, { "name": "nodeCount", "value": "", "type": "query", "description": "Count of virtual machines in this VM cluster." }, { "name": "vmNetworkConsumerType", "value": "", "type": "query", "description": "VM network consumer type." } ] }, "docs": "Obtain a list of VM cluster networks on Data Infrastructure.\n" }, { "info": { "name": "Create a VM cluster network on Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmClusterNetworks", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a VM cluster network on Data Infrastructure using the specified details.\n" }, { "info": { "name": "Generates a recommended VM cluster network configuration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmClusterNetworks/actions/generateRecommendedVmClusterNetwork", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a VM cluster network configuration using the specified details.\n" }, { "info": { "name": "Obtain the VM cluster network on Data Infrastructure.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/vmClusterNetworks/:vmClusterNetworkId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network." } ] }, "docs": "Obtain the VM cluster network on Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Update the VM cluster network on Data Infrastructure.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251101/vmClusterNetworks/:vmClusterNetworkId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the VM cluster network on Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Delete the VM cluster network on Data Infrastructure.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20251101/vmClusterNetworks/:vmClusterNetworkId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network." } ] }, "docs": "Delete the VM cluster network on Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm). It must be called once the resource usage is complete.\n" }, { "info": { "name": "Change the compartment for the VM cluster network on Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmClusterNetworks/:vmClusterNetworkId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the VM cluster network Compartment to the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Download the validation script for the specified VM network.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/vmClusterNetworks/:vmClusterNetworkId/actions/downloadValidationScript", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network." } ] }, "docs": "Download the validation script for the specified VM network." }, { "info": { "name": "Validates a recommended VM cluster network on Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmClusterNetworks/:vmClusterNetworkId/actions/validateVmClusterNetwork", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vmClusterNetworkId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network." } ] }, "docs": "Validates a VM cluster network on Data Infrastructure.\n" }, { "info": { "name": "Obtain a list of VM instances.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/vmInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.\nFor list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided,\nit will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the entire display name given. The match is case sensitive." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return resources that match the specified lifecycle state." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order that you want to use, which is either `ASC` or `DESC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which you want to sort. You can provide only one type of sort order. The default order for `timeCreated` is descending. The default order for `displayName` is ascending. If no value is specified, then `timeCreated` is the default.\nWhen listing software images within the same `version`, using `sortBy=buildIdentifier` is recommended. `buildIdentifier` is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.\n" }, { "name": "infrastructureId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure." }, { "name": "baseServerId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure Server Id." } ] }, "docs": "Obtain a list of VM instances.\n" }, { "info": { "name": "Create a VM instance on Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmInstances", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a VM instance on Data Infrastructure using the specified details.\n" }, { "info": { "name": "Obtain the VM instance on Data Infrastructure.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ] }, "docs": "Obtain the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Update the VM instance on Data Infrastructure.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Delete the VM instance on Data Infrastructure.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ] }, "docs": "Delete the VM instance on Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm). It must be called once the resource usage is complete.\n" }, { "info": { "name": "Change the compartment for VM instance.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the VM instance on Data Infrastructure Compartment to the specified [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Migrate the VM instance on Data Infrastructure to other node.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId/actions/migrate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ] }, "docs": "Migrate the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Restart the VM instance on Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId/actions/restart", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ] }, "docs": "Restart the VM instance on Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Scale the VM instance on Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId/actions/scale", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Scale the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Start the VM instance on Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ] }, "docs": "Start the VM instance on Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Stop the VM instance on Data Infrastructure.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20251101/vmInstances/:vmInstanceId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vmInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance." } ] }, "docs": "Stop the VM instance on Data Infrastructure that has the specified\n[OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Get a list of work request details.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.\nFor list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided,\nit will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied).\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the work request resource." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page." } ] }, "docs": "View a list of work request details in the specified compartment.\n" }, { "info": { "name": "Get the status of a work request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Get the status of the work request having the specified work request [OCID](/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "Get errors for a work request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order that you want to use, which is either `ASC` or `DESC`." } ] }, "docs": "View the list of errors for the work request that have the specified work request [OCID](/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "Get logs for a work request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20251101/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order that you want to use, which is either `ASC` or `DESC`." } ] }, "docs": "View the log entries for the work request that have the specified work request [OCID](/Content/General/Concepts/identifiers.htm).\n" } ] } ], "bundled": true }