Update Network Connector

Updates a specified network connector.

Request

URI

PUT <network service endpoint>/v2.0/network_connectors/<network connector id>

Example:

PUT http://192.168.122.1:9696/v2.0/network_connectors/07993b1c-79e1-4cf6-a663-dc42b9ce37d4

Headers

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

Body Syntax


{
	"network_connector" : {
		"name" : "connector2"
	}
}

Request Parameters

Update only specified parameter.

  • name:

    name for network connector

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

Response

Status Code

  • 200

Headers

  • Content-Type: application/json

Body

Example:


{
	"network_connector" : {
		"id" : "07993b1c-79e1-4cf6-a663-dc42b9ce37d4",
		"name" : "connector2",
		"network_connector_pool_id" : "78380271-954a-4c1a-a76d-43033c7fc9bf",
		"tenant_id" : "29320d5e-dd29-425c-b386-3cbb2754ad03",
		"network_connector_endpoints" : [
			"0e521ed5-62d0-44c9-9c04-2e880b5add21"
		]
	}
}

Elements

  • id:

    ID for this network connector

    • Type: String
  • name:

    name for network connector

    • Type: String
  • network_connector_pool_id:

    A network connector pool id for this network connector.

    • Type: String
  • network_connector_endpoints:

    ID of network connector endpoints belonging to this network connector. Immediate after creation, this value must be empty array.

    • Type: Array of String
  • tenant_id:

    tenant's ID to which this network connector belongs

    • Type: String

Errors

  • 400:
    • Invalid parameter in request body
    • Not updatable parameter is specified in request body
  • 401: Token is not specified or not authorized.
  • 403: Token is not permitted to operate
  • 404: Specified network connector not found