Developer Documentation
Get Segment
Read infra segment
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/segments/{segment-id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Segment ID |
Response
Response
Response BodyResponse Body
200 OK returns
Segment
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"advanced_config": {
"address_pool_paths": [
"string"
],
"connectivity": "string",
"hybrid": false,
"local_egress": false
},
"children": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"marked_for_delete": false,
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"connectivity_path": "string",
"description": "string",
"display_name": "string",
"domain_name": "string",
"id": "string",
"l2_extension": {
"l2vpn_path": "string",
"l2vpn_paths": [
"string"
],
"tunnel_id": 0
},
"ls_id": "string",
"marked_for_delete": false,
"overlay_id": 0,
"parent_path": "string",
"path": "string",
"relative_path": "string",
"resource_type": "string",
"subnets": [
{
"dhcp_ranges": [
"string"
],
"gateway_address": "string",
"network": "string"
}
],
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"transport_zone_path": "string",
"type": "string",
"vlan_ids": [
"string"
]
}| Property Name | Type | Description |
|---|---|---|
| _create_time | integer |
Timestamp of resource creation |
| _create_user | string |
ID of the user who created this resource |
| _last_modified_time | integer |
Timestamp of last modification |
| _last_modified_user | string |
ID of the user who last modified this resource |
| _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| _protection | string |
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
| _revision | integer |
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
| _schema | string |
Schema for this resource |
| _self | SelfResourceLink |
Link to this resource |
| _system_owned | boolean |
Indicates system owned resource |
| advanced_config | SegmentAdvancedConfig |
Advanced configuration for Segment. |
| children | array of ChildPolicyConfigResource |
subtree for this type within policy tree containing nested elements. |
| connectivity_path | string |
Policy path to the connecting Tier-0 or Tier-1. Valid only for segments created under Infra. |
| description | string |
Description of this resource |
| display_name | string |
Defaults to ID if not set |
| domain_name | string |
DNS domain name |
| id | string |
Unique identifier of this resource |
| l2_extension | L2Extension |
Configuration for extending Segment through L2 VPN |
| ls_id | string |
This property is deprecated. The property will continue to work as expected for existing segments. The segments that are newly created with ls_id will be ignored. Sepcify pre-creted logical switch id for Segment. |
| marked_for_delete | boolean |
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. |
| overlay_id | integer |
Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point. |
| parent_path | string |
Path of its parent |
| path | string |
Absolute path of this object |
| relative_path | string |
Path relative from its parent |
| resource_type | string |
The type of this resource. |
| subnets | array of SegmentSubnet |
Subnet configuration. Max 1 subnet |
| tags | array of Tag |
Opaque identifiers meaningful to the API user |
| transport_zone_path | string |
Policy path to the transport zone. Supported for VLAN backed segments as well as Overlay Segments. This field is required for VLAN backed Segments. Auto assigned if only one transport zone exists in the enforcement point. Default transport zone is auto assigned for overlay segments if none specified. |
| type | string |
Segment type based on configuration. Possible values are: DISCONNECTED, EXTENDED, ROUTED, ROUTED_AND_EXTENDED |
| vlan_ids | array of string |
VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with ‘-’ in between. |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | Nothing | Not Found |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
On This Page
Segments Operations
put
delete
delete
delete
delete
delete
delete
get
get
patch
patch
patch
patch
