Jump to

• Request
• Response

ListAutoScalingConfigurations

get

/20181001/autoScalingConfigurations

Lists autoscaling configurations in the specifed compartment.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the entire display name given.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f
• sortBy: string
  The optional field to sort the results by.

  Default Value: NAME

  Allowed Values: [ "ID", "NAME", "TIME_CREATED" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  Pattern: [A-Za-z0-9\-_\.]+

  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list is being retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object AutoScalingConfigurationSummary
  Summary information for an autoscaling configuration.

{
    "items":{
        "$ref":"#/definitions/AutoScalingConfigurationSummary"
    },
    "type":"array"
}

Nested Schema : AutoScalingConfigurationSummary

Type: object

Summary information for an autoscaling configuration.

Show Source

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the autoscaling configuration.
• coolDownInSeconds: integer
  Minimum Value: 0

  For threshold-based autoscaling policies, this value is the minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default. The cooldown period starts when the instance pool reaches the running state. For schedule-based autoscaling policies, this value is not used.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the autoscaling configuration.
• isEnabled: boolean
  Whether the autoscaling configuration is enabled.
• resource(required): object Resource
  Discriminator: type

  A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.
• timeCreated(required): string(date-time)
  The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

{
    "description":"Summary information for an autoscaling configuration.",
    "type":"object",
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the autoscaling configuration.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "id":{
            "description":"The OCID of the autoscaling configuration.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "coolDownInSeconds":{
            "description":"For threshold-based autoscaling policies, this value is the minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default. The cooldown period starts when the instance pool reaches the running state. For schedule-based autoscaling policies, this value is not used.",
            "type":"integer",
            "minimum":"0"
        },
        "isEnabled":{
            "description":"Whether the autoscaling configuration is enabled.",
            "type":"boolean"
        },
        "resource":{
            "$ref":"#/definitions/Resource"
        },
        "definedTags":{
            "additionalProperties":{
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                },
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object"
            },
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "type":"object"
        },
        "freeformTags":{
            "additionalProperties":{
                "type":"string"
            },
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object"
        },
        "timeCreated":{
            "description":"The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        }
    },
    "required":[
        "compartmentId",
        "id",
        "resource",
        "timeCreated"
    ],
    "x-example":"{   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"example_autoscaling_configuration\",   \"id\": \"ocid1.autoscalingconfiguration.<var>unique_ID</var>\",   \"coolDownInSeconds\": 300,   \"isEnabled\": true,   \"resource\": {     \"type\": \"instancePool\",     \"id\": \"ocid1.instancepool.<var>unique_ID</var>\"   },   \"timeCreated\": \"2019-01-18T18:44:45.285Z\" } "
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "additionalProperties":{
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        },
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object"
    },
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "type":"object"
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "additionalProperties":{
        "type":"string"
    },
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object"
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : Resource

Type: object

Discriminator: type

A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.

Show Source

• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the resource that is managed by the autoscaling configuration.
• type(required): string
  Minimum Length: 1

  Maximum Length: 100

  The type of resource.

{
    "description":"A resource that is managed by an autoscaling configuration. The only supported type is instancePool. Each instance pool can have one autoscaling configuration.",
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string",
            "maxLength":"100",
            "minLength":"1",
            "description":"The type of resource."
        },
        "id":{
            "description":"The OCID of the resource that is managed by the autoscaling configuration.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "type",
        "id"
    ],
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    },
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object"
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top