Jump to

• Request
• Response

Get FaultManager object.

get

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

get FaultManager object.

Request

Header Parameters

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

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : FaultManager

Type: object

The FaultManager contains attributes that control fault settings.

Show Source

• apiC3SyncCheckerFaultInterval(required): integer
  Sets how often API C3Sync checker fault check should run. @param apiC3SyncCheckerFaultInterval The number of seconds between API C3Sync checker fault checks.
• faultIds: array faultIds
• healthCheckerFaultInterval(required): integer
  Sets how often health checker fault check should run. @param healthCheckerFaultInterval The number of seconds between health checker fault checks.
• healthCheckerFaultLastRunTime: timestamp
  The elapsed time since health checker fault last run is read only and this operation is unsupported. @param health checker FaultLastRunTime - Unsupported.
• iamC3SyncCheckerFaultInterval(required): integer
  Sets how often IAM C3Sync checker fault check should run. @param iamC3SyncCheckerFaultInterval The number of seconds between IAM C3Sync checker fault checks.
• iamC3SyncCheckerFaultLastRunTime: timestamp
  The elapsed time since Iam C3Sync checker fault last run is read only and this operation is unsupported. @param Iam C3Sync checker FaultLastRunTime - Unsupported.
• 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.
• statusFaultInterval(required): integer
  Sets how often status fault check should run. @param statusFaultInterval The number of seconds between status fault checks.
• statusFaultLastRunTime: timestamp
  The elapsed time since status fault last run is read only and this operation is unsupported. @param statusFaultLastRunTime - Unsupported.

{
    "properties":{
        "statusFaultInterval":{
            "description":" Sets how often status fault check should run. @param statusFaultInterval The number of seconds between status fault checks.",
            "type":"integer"
        },
        "healthCheckerFaultInterval":{
            "description":" Sets how often health checker fault check should run. @param healthCheckerFaultInterval The number of seconds between health checker fault checks.",
            "type":"integer"
        },
        "iamC3SyncCheckerFaultInterval":{
            "description":" Sets how often IAM C3Sync checker fault check should run. @param iamC3SyncCheckerFaultInterval The number of seconds between IAM C3Sync checker fault checks.",
            "type":"integer"
        },
        "apiC3SyncCheckerFaultInterval":{
            "description":" Sets how often API C3Sync checker fault check should run. @param apiC3SyncCheckerFaultInterval The number of seconds between API C3Sync checker fault checks.",
            "type":"integer"
        },
        "statusFaultLastRunTime":{
            "description":" The elapsed time since status fault last run is read only and this operation is unsupported. @param statusFaultLastRunTime - Unsupported.",
            "type":"timestamp"
        },
        "healthCheckerFaultLastRunTime":{
            "description":" The elapsed time since health checker fault last run is read only and this operation is unsupported. @param health checker FaultLastRunTime - Unsupported.",
            "type":"timestamp"
        },
        "iamC3SyncCheckerFaultLastRunTime":{
            "description":" The elapsed time since Iam C3Sync checker fault last run is read only and this operation is unsupported. @param Iam C3Sync checker FaultLastRunTime - Unsupported.",
            "type":"timestamp"
        },
        "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":[
        "statusFaultInterval",
        "healthCheckerFaultInterval",
        "iamC3SyncCheckerFaultInterval",
        "apiC3SyncCheckerFaultInterval"
    ],
    "type":"object",
    "description":" The FaultManager contains attributes that control fault settings."
}

Nested Schema : faultIds

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