NSX-T Data Center REST API

CloudServiceEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Stores information about any service endpoint which is provided in the cloud. Example services include the cloud provided equivalent service for Storage, Database or Load Balancer.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "CloudServiceEndpoint", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "nsx_security_groups": {
      "description": "Stores an array of NSX security groups associated to this cloud service endpoint.", 
      "items": {
        "$ref": "SecurityGroup
      }, 
      "readonly": true, 
      "required": false, 
      "title": "NSX security groups array", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "service_endpoint_id": {
      "description": "Cloud provided ID of the service endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Endpoint ID", 
      "type": "string"
    }, 
    "service_endpoint_type": {
      "description": "Cloud provided type of the service endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Endpoint Type", 
      "type": "string"
    }, 
    "service_name": {
      "description": "Name of the cloud service the endpoint is associated with.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Name", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Cloud Service Endpoint", 
  "type": "object"
}