Jump to

• Request
• Response

List the info about FD CPU and Memory resources.

get

https://{host}:{port}/{basePath}/FaultDomainInfo/getFaultDomainInfo

list the info about FD CPU and Memory resources.

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 : schema

Type: array

Show Source

• Array of: object FaultDomainInfo
  Fault domain CPU and Memory Info

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

Nested Schema : FaultDomainInfo

Type: object

Fault domain CPU and Memory Info

Show Source

• faultDomain: string
  Maximum Length: 64
• faultIds: array faultIds
• freeGPUs: integer
• freeMemory: number
• freevCPUs: integer
• notes: string
  Maximum Length: 64
• totalCNs: integer
• totalGPUs: integer
• totalMemory: number
• totalvCPUs: integer

{
    "properties":{
        "faultDomain":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "totalCNs":{
            "description":"",
            "type":"integer"
        },
        "totalMemory":{
            "description":"",
            "type":"number"
        },
        "freeMemory":{
            "description":"",
            "type":"number"
        },
        "totalvCPUs":{
            "description":"",
            "type":"integer"
        },
        "freevCPUs":{
            "description":"",
            "type":"integer"
        },
        "totalGPUs":{
            "description":"",
            "type":"integer"
        },
        "freeGPUs":{
            "description":"",
            "type":"integer"
        },
        "notes":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "type":"object",
    "description":"Fault domain CPU and Memory Info"
}

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