Jump to

• Request
• Response

Update Job Scheduler Queues

post

/bdcsce/api/v1.1/clustermgmt/{identityDomainId}/instances/{clusterId}/queues

Request

Path Parameters

• clusterId: string
  Identifier for the Cluster
• identityDomainId: string
  Identity domain ID of the Oracle Cloud Service instance, used for authentication.

Body ()

List of Queue Definition that will be set on the Cluster's Job Scheduler.

Root Schema : JobQueuesHttpRequest

Type: object

Show Source

• queues(optional): array queues
  List of Queues that will be set in the Job Scheduler.

{
    "type":"object",
    "properties":{
        "queues":{
            "type":"array",
            "description":"List of Queues that will be set in the Job Scheduler.",
            "items":{
                "$ref":"#/definitions/JobQueue"
            }
        }
    }
}

Nested Schema : queues

Type: array

List of Queues that will be set in the Job Scheduler.

Show Source

• [0]: object JobQueue

{
    "type":"array",
    "description":"List of Queues that will be set in the Job Scheduler.",
    "items":{
        "$ref":"#/definitions/JobQueue"
    }
}

Nested Schema : JobQueue

Type: object

Show Source

• capacity: integer(int32)
  Capacity of the queue.
• currentCapacity(optional): integer(int32)
  Current capacity of the queue.
• maximumCapacity: integer(int32)
  Maximum capacity of the queue.
• name: string
  Name of the queue.
• preemptionDisabled(optional): boolean
  Default Value: false

  Set to `true` if preemption is enabled.
• state: string
  Allowed Values: [ "STOPPED", "RUNNING" ]

  State of the queue.

{
    "type":"object",
    "required":[
        "capacity",
        "maximumCapacity",
        "name",
        "state"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the queue."
        },
        "capacity":{
            "type":"integer",
            "format":"int32",
            "description":"Capacity of the queue."
        },
        "currentCapacity":{
            "type":"integer",
            "format":"int32",
            "description":"Current capacity of the queue."
        },
        "maximumCapacity":{
            "type":"integer",
            "format":"int32",
            "description":"Maximum capacity of the queue."
        },
        "state":{
            "type":"string",
            "description":"State of the queue.",
            "enum":[
                "STOPPED",
                "RUNNING"
            ]
        },
        "preemptionDisabled":{
            "type":"boolean",
            "description":"Set to `true` if preemption is enabled.",
            "default":false
        }
    }
}

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

400 Response

List of errors related to the request.

Body ()

Root Schema : schema

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

The Job Scheduler Queues was not found.

500 Response

An internal error occurred.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  detail
• instance(optional): string
  instance
• o:errorCode(optional): string
  Read Only: true

  error code
• o:errorDetails(optional): array o:errorDetails
  Read Only: true

  error details
• o:errorPath(optional): string
  Read Only: true

  error path
• status: integer(int32)
  status
• title: string
  title
• type(optional): string
  Read Only: true

  RFC Link

{
    "type":"object",
    "required":[
        "status",
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "description":"title"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"status"
        },
        "detail":{
            "type":"string",
            "description":"detail"
        },
        "instance":{
            "type":"string",
            "description":"instance"
        },
        "o:errorCode":{
            "type":"string",
            "description":"error code",
            "readOnly":true
        },
        "o:errorPath":{
            "type":"string",
            "description":"error path",
            "readOnly":true
        },
        "o:errorDetails":{
            "type":"array",
            "description":"error details",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "type":{
            "type":"string",
            "description":"RFC Link",
            "readOnly":true
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Read Only: true

error details

Show Source

• [0]: object Error

{
    "type":"array",
    "description":"error details",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top