[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Create BYOD Service Instance Endpoint
DescriptionCreate service instance endpoint with given request if not exist. Modification of service instance endpoint is not allowed.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/byod-service-instances/{service-instance-id}/service-instance-endpoints/{service-instance-endpoint-id}
Path Parameters
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
string
service-instance-endpoint-id
Required
Service instance endpoint id
Request Body
Request Body
ServiceInstanceEndpoint
of type(s) application/json
Required
This request body class requires all of the following:
BaseEndpoint, InlineServiceInstanceEndpoint1
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
ServiceInstanceEndpoint
of type(s) application/json
This response body class contains all of the following:
BaseEndpoint, InlineServiceInstanceEndpoint1
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
ApiError
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
$ResourceLink = Initialize-nullResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-nullSelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-nullTag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-nullPolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-nullChildPolicyConfigResource -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -MarkForOverride $false -MarkedForDelete $false -RequestParameter $PolicyRequestParameter
$IPInfo = Initialize-nullIPInfo -IpAddresses "MyIpAddresses" -PrefixLength 0
$ServiceInstanceEndpoint = Initialize-nullServiceInstanceEndpoint -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "VirtualEndpoint" -Tags $Tag -OriginSiteId "MyOriginSiteId" -OwnerId "MyOwnerId" -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -RemotePath "MyRemotePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -TargetIps $IPInfo -ServiceInterfacePath "MyServiceInterfacePath"
Invoke-CreateServiceInstanceEndpoint -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -serviceInstanceId "MyserviceInstanceId" -serviceInstanceEndpointId "MyserviceInstanceEndpointId" -serviceInstanceEndpoint $serviceInstanceEndpoint
cURL Command
curl -X PUT -H "Content-Type: application/json" -d '{"_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,"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"}]}],"description":"string","display_name":"string","id":"string","marked_for_delete":false,"parent_path":"string","path":"string","relative_path":"string","resource_type":"VirtualEndpoint","service_interface_path":"string","tags":[{"scope":"string","tag":"string"}],"target_ips":[{"ip_addresses":["string"],"prefix_length":0}]}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/byod-service-instances/{service-instance-id}/service-instance-endpoints/{service-instance-endpoint-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-byod-service-instance-endpoint
x-vmw-nsx-module: PolicyServiceInsertion
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
delete
