Jump to

• Request
• Response

Get a Load Balancer Attachment

get

/20160918/instancePools/{instance_pool_id}/loadBalancerAttachments/{instance_pool_load_balancer_attachment_id}

Get information about a load balancer that is attached to the specified instance pool.

Request

Supported Media Types

• application/json

Path Parameters

• instancePoolId(required): string
  The OCID of the instance pool.
• instancePoolLoadBalancerAttachmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the load balancer attachment.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The load balancer attached to the instance pool was retrieved.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : InstancePoolLoadBalancerAttachment

Type: object

Represents a load balancer that is attached to an instance pool.

Show Source

• backendSetName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the backend set on the load balancer.
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the load balancer attachment.
• instancePoolId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance pool of the load balancer attachment.
• lifecycleState(required): string
  Allowed Values: [ "ATTACHING", "ATTACHED", "DETACHING", "DETACHED" ]

  The status of the interaction between the instance pool and the load balancer.
• loadBalancerId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the load balancer attached to the instance pool.
• port(required): integer
  Minimum Value: 0

  Maximum Value: 65535

  The port value used for the backends.
• vnicSelection(required): string
  Minimum Length: 1

  Maximum Length: 255

  Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

{
    "description":"Represents a load balancer that is attached to an instance pool.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the load balancer attachment.",
            "minLength":1,
            "maxLength":255
        },
        "instancePoolId":{
            "type":"string",
            "description":"The OCID of the instance pool of the load balancer attachment.",
            "minLength":1,
            "maxLength":255
        },
        "loadBalancerId":{
            "type":"string",
            "description":"The OCID of the load balancer attached to the instance pool.",
            "minLength":1,
            "maxLength":255
        },
        "backendSetName":{
            "type":"string",
            "description":"The name of the backend set on the load balancer.",
            "minLength":1,
            "maxLength":255
        },
        "port":{
            "type":"integer",
            "description":"The port value used for the backends.",
            "maximum":65535,
            "minimum":0
        },
        "vnicSelection":{
            "type":"string",
            "description":"Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are \"PrimaryVnic\" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.",
            "maxLength":255,
            "minLength":1
        },
        "lifecycleState":{
            "description":"The status of the interaction between the instance pool and the load balancer.",
            "type":"string",
            "enum":[
                "ATTACHING",
                "ATTACHED",
                "DETACHING",
                "DETACHED"
            ]
        }
    },
    "required":[
        "id",
        "instancePoolId",
        "loadBalancerId",
        "backendSetName",
        "port",
        "vnicSelection",
        "lifecycleState"
    ],
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top