Jump to

• Request
• Response

Modify the CnUpdateManager object.

put

https://{host}:{port}/{basePath}/CnUpdateManager/

modify the CnUpdateManager object.

Request

Path Parameters

• CnUpdateManagerId(required):
  CnUpdateManagerId to modify the associated CnUpdateManager.

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• cnUpdateManager: object CnUpdateManager
  The CnUpdateManager contains attributes that control how often we should pull the compute service for updates.

{
    "properties":{
        "cnUpdateManager":{
            "$ref":"#/components/schemas/CnUpdateManager",
            "type":"object"
        }
    }
}

Nested Schema : CnUpdateManager

Type: object

The CnUpdateManager contains attributes that control how often we should pull the compute service for updates.

Show Source

• cpuUsageCriticalFaultPercent(required): number
  Sets the minimum CPU usage percentage to trigger critical faults. @param minimum CPU usage percentage to trigger a critical fault.
• cpuUsageMajorFaultPercent(required): number
  Sets the minimum CPU usage percentage to trigger major faults. @param minimum CPU usage percentage to trigger major faults
• cpuUsageMinorFaultPercent(required): number
  Sets the minimum CPU usage percentage to trigger minor faults. @param minimum CPU usage percentage to trigger minor faults
• cpuUsageWarningPercent(required): number
  Sets the minimum CPU usage percentage to trigger a warning. @param minimum CPU usage percentage to trigger a warning
• faultIds: array faultIds
• lastRunTime: timestamp
  The elapsed time since last run is read only and this operation is unsupported. @param lastRunTime - Unsupported.
• memoryUsageCriticalFaultPercent(required): number
  Sets the minimum memory usage percentage to trigger critical faults. @param minimum memory usage percentage to trigger a critical fault.
• memoryUsageMajorFaultPercent(required): number
  Sets the minimum memory usage percentage to trigger major faults. @param minimum memory usage percentage to trigger major faults
• memoryUsageMinorFaultPercent(required): number
  Sets the minimum memory usage percentage to trigger minor faults. @param minimum memory usage percentage to trigger minor faults
• memoryUsageWarningPercent(required): number
  Sets the minimum memory usage percentage to trigger a warning. @param minimum memory usage percentage to trigger a warning
• pollInterval: integer
  Sets the poll interval. @param purgeInterval the poll interval in seconds
• runState: string
  Allowed Values: [ "RUNNING", "STOPPED", "UNKNOWN" ]

  The Manager's run state is read-only and this operation is unsupported. @param runState to set manager to.
• totalCnCpuUsageCriticalFaultPercent(required): number
  Sets the minimum total CN CPU usage percentage to trigger critical faults. @param minimum total CN CPU usage percentage to trigger a critical fault.
• totalCnCpuUsageMajorFaultPercent(required): number
  Sets the minimum total CN CPU usage percentage to trigger major faults. @param minimum total CN CPU usage percentage to trigger major faults
• totalCnCpuUsageMinorFaultPercent(required): number
  Sets the minimum total CN CPU usage percentage to trigger minor faults. @param minimum total CN CPU usage percentage to trigger minor faults
• totalCnCpuUsageWarningPercent(required): number
  Sets the minimum total CN CPU usage percentage to trigger a warning. @param minimum total CN CPU usage percentage to trigger a warning
• totalCnMemoryUsageCriticalFaultPercent(required): number
  Sets the minimum total CN memory usage percentage to trigger critical faults. @param minimum total CN memory usage percentage to trigger a critical fault.
• totalCnMemoryUsageMajorFaultPercent(required): number
  Sets the minimum total CN memory usage percentage to trigger major faults. @param minimum total CN memory usage percentage to trigger major faults
• totalCnMemoryUsageMinorFaultPercent(required): number
  Sets the minimum total CN memory usage percentage to trigger minor faults. @param minimum total CN memory usage percentage to trigger minor faults
• totalCnMemoryUsageWarningPercent(required): number
  Sets the minimum total CN memory usage percentage to trigger a warning. @param minimum total CN memory usage percentage to trigger a warning

{
    "properties":{
        "lastRunTime":{
            "description":" The elapsed time since last run is read only and this operation is unsupported. @param lastRunTime - Unsupported.",
            "type":"timestamp"
        },
        "pollInterval":{
            "description":"Sets the poll interval. @param purgeInterval the poll interval in seconds",
            "type":"integer"
        },
        "cpuUsageCriticalFaultPercent":{
            "description":"Sets the minimum CPU usage percentage to trigger critical faults. @param minimum CPU usage percentage to trigger a critical fault.",
            "type":"number"
        },
        "cpuUsageMajorFaultPercent":{
            "description":"Sets the minimum CPU usage percentage to trigger major faults. @param minimum CPU usage percentage to trigger major faults",
            "type":"number"
        },
        "cpuUsageMinorFaultPercent":{
            "description":"Sets the minimum CPU usage percentage to trigger minor faults. @param minimum CPU usage percentage to trigger minor faults",
            "type":"number"
        },
        "cpuUsageWarningPercent":{
            "description":"Sets the minimum CPU usage percentage to trigger a warning. @param minimum CPU usage percentage to trigger a warning",
            "type":"number"
        },
        "memoryUsageCriticalFaultPercent":{
            "description":"Sets the minimum memory usage percentage to trigger critical faults. @param minimum memory usage percentage to trigger a critical fault.",
            "type":"number"
        },
        "memoryUsageMajorFaultPercent":{
            "description":"Sets the minimum memory usage percentage to trigger major faults. @param minimum memory usage percentage to trigger major faults",
            "type":"number"
        },
        "memoryUsageMinorFaultPercent":{
            "description":"Sets the minimum memory usage percentage to trigger minor faults. @param minimum memory usage percentage to trigger minor faults",
            "type":"number"
        },
        "memoryUsageWarningPercent":{
            "description":"Sets the minimum memory usage percentage to trigger a warning. @param minimum memory usage percentage to trigger a warning",
            "type":"number"
        },
        "totalCnCpuUsageCriticalFaultPercent":{
            "description":"Sets the minimum total CN CPU usage percentage to trigger critical faults. @param minimum total CN CPU usage percentage to trigger a critical fault.",
            "type":"number"
        },
        "totalCnCpuUsageMajorFaultPercent":{
            "description":"Sets the minimum total CN CPU usage percentage to trigger major faults. @param minimum total CN CPU usage percentage to trigger major faults",
            "type":"number"
        },
        "totalCnCpuUsageMinorFaultPercent":{
            "description":"Sets the minimum total CN CPU usage percentage to trigger minor faults. @param minimum total CN CPU usage percentage to trigger minor faults",
            "type":"number"
        },
        "totalCnCpuUsageWarningPercent":{
            "description":"Sets the minimum total CN CPU usage percentage to trigger a warning. @param minimum total CN CPU usage percentage to trigger a warning",
            "type":"number"
        },
        "totalCnMemoryUsageCriticalFaultPercent":{
            "description":"Sets the minimum total CN memory usage percentage to trigger critical faults. @param minimum total CN memory usage percentage to trigger a critical fault.",
            "type":"number"
        },
        "totalCnMemoryUsageMajorFaultPercent":{
            "description":"Sets the minimum total CN memory usage percentage to trigger major faults. @param minimum total CN memory usage percentage to trigger major faults",
            "type":"number"
        },
        "totalCnMemoryUsageMinorFaultPercent":{
            "description":"Sets the minimum total CN memory usage percentage to trigger minor faults. @param minimum total CN memory usage percentage to trigger minor faults",
            "type":"number"
        },
        "totalCnMemoryUsageWarningPercent":{
            "description":"Sets the minimum total CN memory usage percentage to trigger a warning. @param minimum total CN memory usage percentage to trigger a warning",
            "type":"number"
        },
        "runState":{
            "description":"The Manager's run state is read-only and this operation is unsupported. @param runState to set manager to.",
            "enum":[
                "RUNNING",
                "STOPPED",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "cpuUsageCriticalFaultPercent",
        "cpuUsageMajorFaultPercent",
        "cpuUsageMinorFaultPercent",
        "cpuUsageWarningPercent",
        "memoryUsageCriticalFaultPercent",
        "memoryUsageMajorFaultPercent",
        "memoryUsageMinorFaultPercent",
        "memoryUsageWarningPercent",
        "totalCnCpuUsageCriticalFaultPercent",
        "totalCnCpuUsageMajorFaultPercent",
        "totalCnCpuUsageMinorFaultPercent",
        "totalCnCpuUsageWarningPercent",
        "totalCnMemoryUsageCriticalFaultPercent",
        "totalCnMemoryUsageMajorFaultPercent",
        "totalCnMemoryUsageMinorFaultPercent",
        "totalCnMemoryUsageWarningPercent"
    ],
    "type":"object",
    "description":"The CnUpdateManager contains attributes that control how often we should pull the compute service for updates."
}

Nested Schema : faultIds

Type: array

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : Job

Type: object

A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects.

Show Source

• abortedUser: string
  Maximum Length: 256
• associatedObjId: string
  Maximum Length: 128
• associatedObjType: string
  Maximum Length: 256
• endTime: timestamp
  Read-only and this operation is unsupported. @param endTime Time in milliseconds.
• jobName(required): string
  Maximum Length: 256
• progressMessage: string
  Maximum Length: 1024

  Read-only and this operation is unsupported. @param progressMessage.
• result: AssociatedObj
• runState: string
  Allowed Values: [ "ACTIVE", "SUCCEEDED", "FAILED", "ABORTED" ]
• startTime: timestamp
  Read-only and this operation is unsupported. @param startTime The startTime to set.
• transcript: string
  Maximum Length: 1000
• username: string
  Maximum Length: 64
• workItemIds: array workItemIds
• workRequestId: string
  Maximum Length: 256

{
    "properties":{
        "result":{
            "description":"",
            "type":"AssociatedObj"
        },
        "associatedObjType":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "associatedObjId":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "workRequestId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "abortedUser":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "endTime":{
            "description":"Read-only and this operation is unsupported. @param endTime Time in milliseconds.",
            "type":"timestamp"
        },
        "jobName":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "progressMessage":{
            "description":"Read-only and this operation is unsupported. @param progressMessage.",
            "maxLength":1024,
            "type":"string"
        },
        "runState":{
            "description":"",
            "enum":[
                "ACTIVE",
                "SUCCEEDED",
                "FAILED",
                "ABORTED"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"Read-only and this operation is unsupported. @param startTime The startTime to set.",
            "type":"timestamp"
        },
        "transcript":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "username":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "workItemIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "jobName"
    ],
    "type":"object",
    "description":"A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects."
}

Nested Schema : workItemIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

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

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

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

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

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

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

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

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

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

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

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

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

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

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

Back to Top