{ "opencollection": "1.0.0", "info": { "name": "Cloud Advisor Optimizer API", "version": "20200606" }, "items": [ { "info": { "name": "optimizer", "type": "folder" }, "items": [ { "info": { "name": "Include a list of resource actions.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200606/actions/filterResourceActions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.\n\nCan only be set to true when performing ListCompartments on the tenancy (root compartment).\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queries the Cloud Advisor resource actions that are supported.\n" }, { "info": { "name": "Include a list of optimizer categories that are currently supported.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/categories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.\n\nCan only be set to true when performing ListCompartments on the tenancy (root compartment).\n" }, { "name": "name", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the name specified." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns results that match the lifecycle state specified.\n" } ] }, "docs": "Lists the supported Cloud Advisor categories.\n" }, { "info": { "name": "Get the category for the OCID specified.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/categories/:categoryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "categoryId", "value": "", "type": "path", "description": "The unique OCID associated with the category." } ] }, "docs": "Gets the category that corresponds to the specified OCID.\n" }, { "info": { "name": "Lists the Cloud Advisor enrollment statuses.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/enrollmentStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns results that match the lifecycle state specified.\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter that returns results that match the Cloud Advisor enrollment status specified.\n" } ] }, "docs": "Lists the Cloud Advisor enrollment statuses.\n" }, { "info": { "name": "Returns the optimizer enrollment status.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/enrollmentStatus/:enrollmentStatusId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "enrollmentStatusId", "value": "", "type": "path", "description": "The unique OCID associated with the enrollment status." } ] }, "docs": "Gets the Cloud Advisor enrollment status.\n" }, { "info": { "name": "Update the enrollment status of the tenancy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200606/enrollmentStatus/:enrollmentStatusId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "enrollmentStatusId", "value": "", "type": "path", "description": "The unique OCID associated with the enrollment status." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the enrollment status of the tenancy.\n" }, { "info": { "name": "Included a list of recommendation history changes.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/histories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.\n\nCan only be set to true when performing ListCompartments on the tenancy (root compartment).\n" }, { "name": "name", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the name specified." }, { "name": "recommendationName", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the recommendation name specified." }, { "name": "recommendationId", "value": "", "type": "query", "description": "The unique OCID associated with the recommendation." }, { "name": "resourceType", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the resource type specified." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns results that match the lifecycle state specified.\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter that returns recommendations that match the status specified.\n" } ] }, "docs": "Lists changes to the recommendations based on user activity. \nFor example, lists when recommendations have been implemented, dismissed, postponed, or reactivated.\n" }, { "info": { "name": "Lists the existing profile levels.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/profileLevels", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.\n\nCan only be set to true when performing ListCompartments on the tenancy (root compartment).\n" }, { "name": "name", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the name specified." }, { "name": "recommendationName", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the recommendation name specified." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" } ] }, "docs": "Lists the existing profile levels.\n" }, { "info": { "name": "Lists the existing profiles.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/profiles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "name", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the name specified." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns results that match the lifecycle state specified.\n" } ] }, "docs": "Lists the existing profiles.\n" }, { "info": { "name": "Creates a new profile.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200606/profiles", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new profile.\n" }, { "info": { "name": "Gets the specified profile's information. Uses the profile's OCID to determine which profile to retrieve.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/profiles/:profileId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The unique OCID of the profile." } ] }, "docs": "Gets the specified profile's information. Uses the profile's OCID to determine which profile to retrieve.\n" }, { "info": { "name": "Updates the specified profile. Uses the profile's OCID to determine which profile to update.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200606/profiles/:profileId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The unique OCID of the profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified profile. Uses the profile's OCID to determine which profile to update.\n" }, { "info": { "name": "Deletes the specified profile. Uses the profile's OCID to determine which profile to delete.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20200606/profiles/:profileId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The unique OCID of the profile." } ] }, "docs": "Deletes the specified profile. Uses the profile's OCID to determine which profile to delete.\n" }, { "info": { "name": "Lists the existing strategies.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/recommendationStrategies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.\n\nCan only be set to true when performing ListCompartments on the tenancy (root compartment).\n" }, { "name": "name", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the name specified." }, { "name": "recommendationName", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the recommendation name specified." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" } ] }, "docs": "Lists the existing strategies.\n" }, { "info": { "name": "Include a list of optimizer recommendations.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/recommendations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.\n\nCan only be set to true when performing ListCompartments on the tenancy (root compartment).\n" }, { "name": "categoryId", "value": "", "type": "query", "description": "The unique OCID associated with the category." }, { "name": "name", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the name specified." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns results that match the lifecycle state specified.\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter that returns recommendations that match the status specified.\n" } ] }, "docs": "Lists the Cloud Advisor recommendations that are currently supported.\n" }, { "info": { "name": "Get the recommendation for the OCID specified.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/recommendations/:recommendationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "recommendationId", "value": "", "type": "path", "description": "The unique OCID associated with the recommendation." } ] }, "docs": "Gets the recommendation for the specified OCID.\n" }, { "info": { "name": "Updates the recommendation with the given OCID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200606/recommendations/:recommendationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "recommendationId", "value": "", "type": "path", "description": "The unique OCID associated with the recommendation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the recommendation that corresponds to the specified OCID.\nUse this operation to implement the following actions:\n\n * Postpone recommendation\n * Dismiss recommendation\n * Reactivate recommendation\n" }, { "info": { "name": "Applies the specified recommendations to the resources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20200606/recommendations/:recommendationId/actions/bulkApplyRecommendations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "recommendationId", "value": "", "type": "path", "description": "The unique OCID associated with the recommendation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies the specified recommendations to the resources.\n" }, { "info": { "name": "Include a list of resource actions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/resourceActions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.\n\nCan only be set to true when performing ListCompartments on the tenancy (root compartment).\n" }, { "name": "name", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the name specified." }, { "name": "resourceType", "value": "", "type": "query", "description": "Optional. A filter that returns results that match the resource type specified." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns results that match the lifecycle state specified.\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter that returns recommendations that match the status specified.\n" } ] }, "docs": "Lists the Cloud Advisor resource actions that are supported.\n" }, { "info": { "name": "List of all the fields and their value type that are indexed for querying resource actions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/resourceActions/actions/getQueryableFields", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.\n\nCan only be set to true when performing ListCompartments on the tenancy (root compartment).\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" } ] }, "docs": "Lists the fields that are indexed for querying and their associated value types.\n" }, { "info": { "name": "Get the resource action for the OCID specified.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/resourceActions/:resourceActionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resourceActionId", "value": "", "type": "path", "description": "The unique OCID associated with the resource action." } ] }, "docs": "Gets the resource action that corresponds to the specified OCID.\n" }, { "info": { "name": "Updates the resource action with the given OCID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20200606/resourceActions/:resourceActionId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "resourceActionId", "value": "", "type": "path", "description": "The unique OCID associated with the resource action." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the resource action that corresponds to the specified OCID. \nUse this operation to implement the following actions:\n\n * Postpone resource action\n * Ignore resource action\n * Reactivate resource action\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." } ] }, "docs": "Lists the work requests in the tenancy. The tenancy is the root compartment.\n" }, { "info": { "name": "Get Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Gets the status of the work request associated with the specified ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." } ] }, "docs": "Lists errors associated with the specified work request.\n" }, { "info": { "name": "Lists the work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20200606/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." } ] }, "docs": "Lists the logs associated with the specified work request.\n" } ] } ], "bundled": true }