Get MSTP Instance Status (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/mstp_instances/:mstp_instance_id/status

List the MSTP instance status for a specific ID.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

mstp_instance_id stringrequired

The MSTP instance ID.

Responses

200

Successful Operation

application/json

Schema

Schema

bridge_mac_address string

The bridge MAC address.

disabled boolean

Indicates if the MSTP instance is disabled.

disabled_reason string

The reason for the MSTP instance to be disabled.

element_id string

The element ID.

id string

The ID.

inactive boolean

Indicates if the MSTP instance is inactive.

inactive_reason string

The reason for the MSTP instance to be inactive.

instance_number integer

The MSTP instance number. Valid values are 0-255.

instance_priority integer

The MSTP instance priority. Valid values are 0-15.

mstp_instance_id string

The MSTP instance ID.

region string

The region of the radius.

site_id stringrequired

The site ID.

stp_mode string

The STP Mode is RSTP (default).

tenant_id stringrequired

The tenant ID.

Example (from schema)

{
  "bridge_mac_address": "string",
  "disabled": true,
  "disabled_reason": "string",
  "element_id": "string",
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "instance_number": 0,
  "instance_priority": 0,
  "mstp_instance_id": "string",
  "region": "string",
  "site_id": "string",
  "stp_mode": "string",
  "tenant_id": "string"
}

404

Not Found

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "MSTP_INSTANCE_STATUS_NOT_FOUND"
      }
    ]
  }
}

Loading...