{ "opencollection": "1.0.0", "info": { "name": "Auto Scaling API", "version": "20181001" }, "items": [ { "info": { "name": "autoScaling", "type": "folder" }, "items": [ { "info": { "name": "ListAutoScalingConfigurations", "type": "http" }, "http": { "method": "GET", "url": "/20181001/autoScalingConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresource. Use tenancyId to search in\nthe root compartment.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of items to return in a paginated \"List\" call. For important details\nabout how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [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\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\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 autoscaling configurations in the specifed compartment.\n" }, { "info": { "name": "CreateAutoScalingConfiguration", "type": "http" }, "http": { "method": "POST", "url": "/20181001/autoScalingConfigurations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an autoscaling configuration." }, { "info": { "name": "GetAutoScalingConfiguration", "type": "http" }, "http": { "method": "GET", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." } ] }, "docs": "Gets information about the specified autoscaling configuration." }, { "info": { "name": "UpdateAutoScalingConfiguration", "type": "http" }, "http": { "method": "PUT", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period,\nand whether the autoscaling configuration is enabled.\n" }, { "info": { "name": "DeleteAutoScalingConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." } ] }, "docs": "Deletes an autoscaling configuration." }, { "info": { "name": "ChangeAutoScalingConfigurationCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an autoscaling configuration into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an autoscaling configuration to a different compartment, associated resources such as instance\npools are not moved.\n" }, { "info": { "name": "ListAutoScalingPolicies", "type": "http" }, "http": { "method": "GET", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId/policies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of items to return in a paginated \"List\" call. For important details\nabout how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [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\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\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 autoscaling policies in the specified autoscaling configuration.\n" }, { "info": { "name": "CreateAutoScalingPolicy", "type": "http" }, "http": { "method": "POST", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId/policies", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an autoscaling policy for the specified autoscaling configuration.\n\nYou can create the following types of autoscaling policies:\n\n- **Schedule-based:** Autoscaling events take place at the specific times that you schedule.\n- **Threshold-based:** An autoscaling action is triggered when a performance metric meets or exceeds a threshold.\n\nAn autoscaling configuration can either have multiple schedule-based autoscaling policies, or one\nthreshold-based autoscaling policy.\n" }, { "info": { "name": "GetAutoScalingPolicy", "type": "http" }, "http": { "method": "GET", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId/policies/:autoScalingPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." }, { "name": "autoScalingPolicyId", "value": "", "type": "path", "description": "The ID of the autoscaling policy." } ] }, "docs": "Gets information about the specified autoscaling policy in the specified autoscaling configuration." }, { "info": { "name": "UpdateAutoScalingPolicy", "type": "http" }, "http": { "method": "PUT", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId/policies/:autoScalingPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." }, { "name": "autoScalingPolicyId", "value": "", "type": "path", "description": "The ID of the autoscaling policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an autoscaling policy in the specified autoscaling configuration." }, { "info": { "name": "DeleteAutoScalingPolicy", "type": "http" }, "http": { "method": "DELETE", "url": "/20181001/autoScalingConfigurations/:autoScalingConfigurationId/policies/:autoScalingPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration." }, { "name": "autoScalingPolicyId", "value": "", "type": "path", "description": "The ID of the autoscaling policy." } ] }, "docs": "Deletes an autoscaling policy for the specified autoscaling configuration." } ] } ], "bundled": true }