Jump to

• Request
• Response

Get all Fault objects that meet the filter criteria.

put

https://{host}:{port}/{basePath}/Fault/filter

get all Fault objects that meet the filter criteria.

Request

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

• filter: object Filter

{
    "properties":{
        "filter":{
            "$ref":"#/components/schemas/Filter",
            "type":"object"
        }
    }
}

Nested Schema : Filter

Type: object

Show Source

• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• filterConditions: array filterConditions
• generation: integer
• maxResults: integer
• name(required): string
  Maximum Length: 256
• objType: string
  Maximum Length: 64
• orderByList: array orderByList
• orderType: string
  Allowed Values: [ "ASCENDING", "DESCENDING" ]
• workState: string

{
    "properties":{
        "objType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "maxResults":{
            "description":"",
            "type":"integer"
        },
        "orderByList":{
            "description":"",
            "type":"array"
        },
        "orderType":{
            "description":"",
            "enum":[
                "ASCENDING",
                "DESCENDING"
            ],
            "type":"string"
        },
        "filterConditions":{
            "description":"",
            "type":"array"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":""
}

Nested Schema : faultIds

Type: array

Nested Schema : filterConditions

Type: array

Nested Schema : orderByList

Type: array

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Fault
  A Fault represents an abnormal condition within the Admin Server.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Fault"
    }
}

Nested Schema : Fault

Type: object

A Fault represents an abnormal condition within the Admin Server.

Show Source

• action: string
  Maximum Length: 1028
• activatedTime: timestamp
• asrNotifTime: timestamp
• associatedAttribute: string
  Maximum Length: 256

  The fault associated attribute is read-only and this operation is unsupported.
• baseManagedObjectId: object BaseManagedObject
• category: string
  Allowed Values: [ "STATUS", "STATISTICAL", "INTERNAL", "HEALTHCHECKER" ]

  The fault category is read-only and this operation is unsupported.
• cause: string
  Maximum Length: 1000

  The fault cause is read-only and this operation is unsupported.
• cccFaultId: string
  Maximum Length: 256
• cccNotifTime: timestamp
• clearedTime: timestamp
• componentType: string
  Maximum Length: 64
• customNotes(required): string
  Maximum Length: 256

  @param customNotes Set the custom notes for this fault.
• description(required): string
  Maximum Length: 1000
• diagnosingSource: string
  Maximum Length: 64
• faultCode: string
  Allowed Values: [ "BACKUP_FAILURE", "BACKUP_PURGE_FAILURE", "INVALID_RACK_COMPONENTS", "COMPUTENODE_DISCOVERY_FAULT", "INVALID_RACK_OR_SWITCH_CONFIG_FILE", "DHCP_SERVICE_FAULT", "DNS_SERVICE_FAULT", "MGMT_NETWORKSWITCH_FAULT", "STATISTIC_MONITOR_HOLD_TIME_MODIFIED", "STATISTIC_MONITOR_INTERVAL_ADJUSTED", "STATISTIC_MONITOR_COLLECTION_DISABLED", "STATISTIC_MONITOR_FULLNESS_EXCEEDED" ]

  The fault code is read-only and this operation is unsupported.
• faultHistoryLogIds: array faultHistoryLogIds
• faultIds: array faultIds
• generation: integer
• healthExporter: string
  Maximum Length: 64
• lastUpdateTime: timestamp
  The last update time is read-only and this operation is unsupported.
• location: string
  Maximum Length: 64
• messageId: string
  Maximum Length: 64
• name(required): string
  Maximum Length: 256
• severity: string
  Allowed Values: [ "CRITICAL", "MAJOR", "MINOR", "WARNING" ]

  The fault severity is read-only and this operation is unsupported.
• status: string
  Allowed Values: [ "ACTIVE", "CLEARED" ]

  The fault staus is read-only and this operation is unsupported.
• timeReported: string
  Maximum Length: 128
• upgradeFault: string
  Maximum Length: 64
• uuid: string
  Maximum Length: 64
• workState: string

{
    "properties":{
        "category":{
            "description":"The fault category is read-only and this operation is unsupported.",
            "enum":[
                "STATUS",
                "STATISTICAL",
                "INTERNAL",
                "HEALTHCHECKER"
            ],
            "type":"string"
        },
        "faultCode":{
            "description":"The fault code is read-only and this operation is unsupported.",
            "enum":[
                "BACKUP_FAILURE",
                "BACKUP_PURGE_FAILURE",
                "INVALID_RACK_COMPONENTS",
                "COMPUTENODE_DISCOVERY_FAULT",
                "INVALID_RACK_OR_SWITCH_CONFIG_FILE",
                "DHCP_SERVICE_FAULT",
                "DNS_SERVICE_FAULT",
                "MGMT_NETWORKSWITCH_FAULT",
                "STATISTIC_MONITOR_HOLD_TIME_MODIFIED",
                "STATISTIC_MONITOR_INTERVAL_ADJUSTED",
                "STATISTIC_MONITOR_COLLECTION_DISABLED",
                "STATISTIC_MONITOR_FULLNESS_EXCEEDED"
            ],
            "type":"string"
        },
        "severity":{
            "description":"The fault severity is read-only and this operation is unsupported.",
            "enum":[
                "CRITICAL",
                "MAJOR",
                "MINOR",
                "WARNING"
            ],
            "type":"string"
        },
        "status":{
            "description":"The fault staus is read-only and this operation is unsupported.",
            "enum":[
                "ACTIVE",
                "CLEARED"
            ],
            "type":"string"
        },
        "associatedAttribute":{
            "description":"The fault associated attribute is read-only and this operation is unsupported.",
            "maxLength":256,
            "type":"string"
        },
        "customNotes":{
            "description":"@param customNotes  Set the custom notes for this fault.",
            "maxLength":256,
            "type":"string"
        },
        "lastUpdateTime":{
            "description":"The last update time is read-only and this operation is unsupported.",
            "type":"timestamp"
        },
        "cause":{
            "description":"The fault cause is read-only and this operation is unsupported.",
            "maxLength":1000,
            "type":"string"
        },
        "messageId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeReported":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "action":{
            "description":"",
            "maxLength":1028,
            "type":"string"
        },
        "healthExporter":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "uuid":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "diagnosingSource":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "location":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "upgradeFault":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "componentType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "cccFaultId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "cccNotifTime":{
            "description":"",
            "type":"timestamp"
        },
        "asrNotifTime":{
            "description":"",
            "type":"timestamp"
        },
        "activatedTime":{
            "description":"",
            "type":"timestamp"
        },
        "clearedTime":{
            "description":"",
            "type":"timestamp"
        },
        "faultHistoryLogIds":{
            "description":"",
            "type":"array"
        },
        "baseManagedObjectId":{
            "description":"",
            "$ref":"#/components/schemas/BaseManagedObject"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "customNotes",
        "description",
        "name"
    ],
    "type":"object",
    "description":"A Fault represents an abnormal condition within the Admin Server."
}

Nested Schema : BaseManagedObject

Type: object

Show Source

• faultIds: array faultIds
  Associated fault Ids.
• id: id
  Object Id.

{
    "properties":{
        "id":{
            "description":"Object Id.",
            "type":"id"
        },
        "faultIds":{
            "description":"Associated fault Ids.",
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : faultHistoryLogIds

Type: array

Nested Schema : faultIds

Type: array

Nested Schema : faultIds

Type: array

Associated fault Ids.

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