Create Network Connector Endpoint

Creates a network connector endpoint.

Request

URI

POST <network service endpoint>/v2.0/network_connector_endpoints

Example:

POST http://192.168.122.1:9696/v2.0/network_connector_endpoints

Headers

  • X-Auth-Token: token delivered by identity service
  • Content-Type: application/json

Body Syntax


{
	"network_connector_endpoint" : {
		"name": "endpoint_for_az1",
		"network_connector_id": "07993b1c-79e1-4cf6-a663-dc42b9ce37d4",
		"endpoint_type": "availability_zone",
		"location" : "east-jp-az1",
		"tenant_id" : "29320d5e-dd29-425c-b386-3cbb2754ad03"
	}
}   
     

Request Parameters

  • name:

    Name for this network connector endpoint.

    • Type: String
    • Constraints: Up to 255 characters in length
    • Constraints: a-z, A-Z, 0-9, and _-
    • Required: Yes
  • network_connector_id:

    ID of network connector to which this network connector endpoint belongs.

    • Type: String
    • Required: Yes
  • endpoint_type:

    type of this network connector endpoint.

    • Type: String
    • Constraints: "availability_zone" or "remote"
    • Required: Yes
  • location:

    location of this network connector endpoint in the endpoint_type.

    • Type: String
    • Required: Yes
    • Constraints: When type is "availability_zone", this value must be one of availability zone name. When type is "remote", this value express label of location, such as 'intra'.
  • tenant_id:

    The tenant's ID to which this network connector belongs.

    This parameter is restricted for project in which requester joins.

    • Type: String
    • Required: No

Response

Status code

  • 201

Headers

  • Content-Type: application/json

Body

Example:


{
	"network_connector_endpoint" : {
		"id": "6ed3561f-087f-43f9-9a51-bf71f666b80f",
		"name": "endpoint_for_az1",
		"network_connector_id": "07993b1c-79e1-4cf6-a663-dc42b9ce37d4",
		"endpoint_type": "availability_zone",
		"location" : "east-jp-az1",
		"tenant_id" : "29320d5e-dd29-425c-b386-3cbb2754ad03"
	}
}
     

Elements

  • id:

    ID for this network connector endpoint

    • Type: String
  • name:

    Name for this network connector endpoint

    • Type: String
  • network_connector_id:

    ID of network connector to which this network connector endpoint belongs.

    • Type: String
  • endpoint_type:

    Type of this network connector endpoint. This value must be one of "availability_zone" or "remote"

    • Type: String
  • location:

    Location of this network connector endpoint in the endpoint_type. When endpoint_type is "availability_zone", this value is availability_zone name. When endpoint_type is "remote", this value expresses label of location, such as 'intra'.

    • Type: String
  • tenant_id:

    Tenant's ID to which this network connector belongs

    • Type: String

Errors

  • 400: Invalid parameter in request body
  • 401: Token is not specified or not authorized
  • 403: Token is not permitted to operate
  • 404: Network connector not found for specified ID
  • 409: A network endpoint already exists for same condition with combination of endpoint_type and location.
  • 503: Any available resource for network connector endpoint does not remain.