{ "opencollection": "1.0.0", "info": { "name": "Oracle Cloud Agent Compute Instance Agent API", "version": "20180530" }, "items": [ { "info": { "name": "computeInstanceAgent", "type": "folder" }, "items": [ { "info": { "name": "ListInstanceAgentCommandExecutions", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20180530/instanceAgentCommandExecutions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "instanceId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the instance." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\n`TIMECREATED` is descending.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive." } ] }, "docs": "Lists the execution details for Oracle Cloud Agent commands that run on the specified compute\ninstance.\n" }, { "info": { "name": "ListInstanceAgentCommands", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20180530/instanceAgentCommands", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\n`TIMECREATED` is descending.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order\nis case sensitive.\n" } ] }, "docs": "Lists the Oracle Cloud Agent commands issued in a compartment.\n" }, { "info": { "name": "CreateInstanceAgentCommand", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20180530/instanceAgentCommands", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent.\n\nOn Linux instances, the script runs in a bash shell. On Windows instances, the\nscript runs in a batch shell.\n\nCommands that require administrator privileges will run only if Oracle Cloud Agent\nis running with administrator privileges.\n" }, { "info": { "name": "GetInstanceAgentCommand", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20180530/instanceAgentCommands/:instanceAgentCommandId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "instanceAgentCommandId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the command." } ] }, "docs": "Gets information about an Oracle Cloud Agent command." }, { "info": { "name": "CancelInstanceAgentCommand", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20180530/instanceAgentCommands/:instanceAgentCommandId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "instanceAgentCommandId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the command." } ] }, "docs": "Cancels a command that is scheduled to run on a compute instance that is managed\nby Oracle Cloud Agent.\n\nCanceling a command is a best-effort attempt. If the command has already\ncompleted, it will not be canceled.\n" }, { "info": { "name": "GetInstanceAgentCommandExecution", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20180530/instanceAgentCommands/:instanceAgentCommandId/status", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "instanceAgentCommandId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the command." }, { "name": "instanceId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the instance." } ] }, "docs": "Gets information about the status of specified instance agent commandId for the given instanceId." } ] } ], "bundled": true }