Read Policy Service Instance
Read service instance
Request
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-instances/{service-instance-id}
COPY
Path Parameters
string
tier-0-id
Required
Tier-0 id
string
locale-service-id
Required
Locale service id
string
service-instance-id
Required
Service instance id
Responses
200
OK
Returns PolicyServiceInstance of type(s) application/json
This response body class contains all of the following: BasePolicyServiceInstance , InlinePolicyServiceInstance1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"children": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"marked_for_delete": false
}
],
"marked_for_delete": false,
"deployment_mode": "string",
"partner_service_name": "string",
"transport_type": "string",
"attributes": [
{
"attribute_type": "string",
"display_name": "string",
"key": "string",
"read_only": false,
"value": "string"
}
],
"compute_id": "string",
"context_id": "string",
"deployment_spec_name": "string",
"deployment_template_name": "string",
"failure_policy": "string",
"primary_gateway_address": "string",
"primary_interface_mgmt_ip": "string",
"primary_interface_network": "string",
"primary_portgroup_id": "string",
"primary_subnet_mask": "string",
"secondary_gateway_address": "string",
"secondary_interface_mgmt_ip": "string",
"secondary_interface_network": "string",
"secondary_portgroup_id": "string",
"secondary_subnet_mask": "string",
"storage_id": "string"
}
400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
404
Not Found
Operation doesn't return any data structure
412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
Tier 0s Operations
PUT
Create Or Replace Tier0 Locale Services
PUT
Create Policy Service Instance
PUT
Create Service Interface
DELETE
Delete Policy Service Instance
DELETE
Delete Service Interface
DELETE
Delete Tier0 Locale Services
DELETE
Delete Tier0 Locale Services Flood Protection Profile Binding
DELETE
Delete Tier0 Locale Services Session Timer Profile Binding
GET
Get Policy Service Instance Statistics
GET
Get Tier0 Locale Services Flood Protection Profile Binding
GET
Get Tier0 Locale Services Session Timer Profile Binding
GET
List Service Interfaces
GET
List Tier0 Locale Services
PATCH
Patch Policy Service Instance
PATCH
Patch Service Interface
PATCH
Patch Tier0 Locale Services
PATCH
Patch Tier0 Locale Services Flood Protection Profile Binding Map
PATCH
Patch Tier0 Local Services Session Timer Profile Binding Map
GET
Read All Policy Service Instances For Tier0
GET
Read Policy Service Instance
GET
Read Service Interface
GET
Read Tier0 Locale Services
POST
Renew Authentication Tokens For Policy Service Instance Reauth
PUT
Update Tier0 Locale Services Flood Protection Profile Binding
PUT
Update Tier0 Locale Services Session Timer Profile Binding
GET
View Tier0 Locale Services Gateway Firewall