Jump to

• Request
• Response

Get Local Endpoint

get

https://{host}:{port}/{basePath}/LocalEndpoint/getLocalEndpoint

Get Local Endpoint

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

Type: object

oracle.doceng.json.BetterJsonNull@6b899971

Show Source

• datacenterGateway1Ip(required): string
  Maximum Length: 64
• datacenterGateway2Ip(required): string
  Maximum Length: 64
• faultIds: array faultIds
• lifecycleState: string
  Allowed Values: [ "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING", "UPDATED", "FAILED", "UNKNOWN" ]
• lifecycleStateDescription: string
  Maximum Length: 1000
• lifecycleSubState: string
  Allowed Values: [ "CREATING_LOCAL_ENDPOINT", "FAILED_CREATING_LOCAL_ENDPOINT", "CREATING_ZFSSA_LOCAL_ENDPOINT", "FAILED_CREATING_ZFSSA_LOCAL_ENDPOINT", "ACTIVE", "DELETING_LOCAL_ENDPOINT", "FAILED_DELETING_LOCAL_ENDPOINT", "DELETING_ZFSSA_LOCAL_ENDPOINT", "FAILED_DELETING_ZFSSA_LOCAL_ENDPOINT", "UPDATING_LOCAL_ENDPOINT", "FAILED_UPDATING_LOCAL_ENDPOINT", "UPDATING_ZFSSA_LOCAL_ENDPOINT", "FAILED_UPDATING_ZFSSA_LOCAL_ENDPOINT", "UPDATED", "DELETED", "UNKNOWN" ]
• localAsn(required): string
  Maximum Length: 64
• progressRecordIds: array progressRecordIds
• spine1Ip(required): string
  Maximum Length: 64
• spine2Ip(required): string
  Maximum Length: 64
• timeCreated: string
  Maximum Length: 64
• timeUpdated: string
  Maximum Length: 64
• zfsCapacityPoolEndpointIp(required): string
  Maximum Length: 64
• zfsPerformancePoolEndpointIp(required): string
  Maximum Length: 64

{
    "properties":{
        "lifecycleState":{
            "description":"",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "UPDATING",
                "UPDATED",
                "FAILED",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "lifecycleSubState":{
            "description":"",
            "enum":[
                "CREATING_LOCAL_ENDPOINT",
                "FAILED_CREATING_LOCAL_ENDPOINT",
                "CREATING_ZFSSA_LOCAL_ENDPOINT",
                "FAILED_CREATING_ZFSSA_LOCAL_ENDPOINT",
                "ACTIVE",
                "DELETING_LOCAL_ENDPOINT",
                "FAILED_DELETING_LOCAL_ENDPOINT",
                "DELETING_ZFSSA_LOCAL_ENDPOINT",
                "FAILED_DELETING_ZFSSA_LOCAL_ENDPOINT",
                "UPDATING_LOCAL_ENDPOINT",
                "FAILED_UPDATING_LOCAL_ENDPOINT",
                "UPDATING_ZFSSA_LOCAL_ENDPOINT",
                "FAILED_UPDATING_ZFSSA_LOCAL_ENDPOINT",
                "UPDATED",
                "DELETED",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "lifecycleStateDescription":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "timeUpdated":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeCreated":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "spine1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "spine2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "datacenterGateway1Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "datacenterGateway2Ip":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "zfsCapacityPoolEndpointIp":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "zfsPerformancePoolEndpointIp":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "localAsn":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "progressRecordIds":{
            "description":"",
            "type":"array"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "spine1Ip",
        "spine2Ip",
        "datacenterGateway1Ip",
        "datacenterGateway2Ip",
        "zfsCapacityPoolEndpointIp",
        "zfsPerformancePoolEndpointIp",
        "localAsn"
    ],
    "type":"object",
    "description":null
}

Nested Schema : faultIds

Type: array

Nested Schema : progressRecordIds

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