Read Vtep Label Pool

Returns information about the specified virtual tunnel endpoint label pool.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/pools/vtep-label-pools/{pool-id}

COPY

Path Parameters

string

pool-id

Required

Virtual tunnel endpoint label pool ID

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns VtepLabelPool of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineVtepLabelPool1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_create_user": "string",
    "_protection": "string",
    "_create_time": 0,
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "ranges": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "start": 0,
            "end": 0
        }
    ],
    "pool_usage": {
        "total_ids": 0,
        "allocated_ids": 0,
        "free_ids": 0
    }
}

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error