Jump to

• Request
• Response

Get a DR configuration.

get

https://{host}:{port}/{basePath}/DrConfig/drGetConfig

Get a DR configuration.

Request

Query Parameters

• drConfigId(required): string

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

Type: object

PCA DR configuration.

Show Source

• configName(required): string
  Maximum Length: 64
• configState(required): string
  Allowed Values: [ "ENABLED", "DISABLED", "FROZEN" ]
• drConfigId: string
  Maximum Length: 64
• failoverTimeout(required): integer
• faultIds: array faultIds
• message: string
  Maximum Length: 64
• plans: array plans
• replicaLagInSeconds: integer
• replicaState: string
  Maximum Length: 64
• zfsProjectName(required): string
  Maximum Length: 64
• zfsReplicationActionId: string
  Maximum Length: 64
• zfsReplicationTargetPkgId: string
  Maximum Length: 64

{
    "properties":{
        "configState":{
            "description":"",
            "enum":[
                "ENABLED",
                "DISABLED",
                "FROZEN"
            ],
            "type":"string"
        },
        "configName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "drConfigId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "zfsProjectName":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "zfsReplicationActionId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "zfsReplicationTargetPkgId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "plans":{
            "description":"",
            "type":"array"
        },
        "message":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "replicaState":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "replicaLagInSeconds":{
            "description":"",
            "type":"integer"
        },
        "failoverTimeout":{
            "description":"",
            "type":"integer"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "configState",
        "configName",
        "zfsProjectName",
        "failoverTimeout"
    ],
    "type":"object",
    "description":"PCA DR configuration."
}

Nested Schema : faultIds

Type: array

Nested Schema : plans

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