Update tenant_connection

Summary

Update tenant_connection resource.

Type

  • Update

Target object of API

  • tenant_connection

Synchronous/Asynchronous

  • Synchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{api_endpoint}/v2.0/tenant_connections/{tenant_connection_id}

HTTP Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>

HTTP Request Body

Format

{
  "tenant_connection":{
    "name": "<name>",
    "description": "<description>",
    "tags":{},
    "name_other": "<name_other>",
    "description_other": "<description_other>",
    "tags_other": {}
  }
}

Parameters

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
token_id Header authentication token string(32) keystone authentication token required   Terminate 401
tenant_connection_id URL String(UUID)   required   Terminate 404
tenant_connection Body Object   required   Terminate 400
name Body String(255) Name of tenant_connection (the owner tenant of device can update this field) optional   Terminate 400
description Body String(255) Description of tenant_connection (the owner tenant of device can update this field) optional   Terminate 400
tags Body Object Tags of tenant_connection (the owner tenant of device can update this field) optional   Terminate 400
name_other Body String(255) Other name of tenant_connection for the owner of network (the owner tenant of network can update this field) optional   Terminate 400
description_other Body String(255) Other description of tenant_connection for the owner of network (the owner tenant of network can update this field) optional   Terminate 400
tags_other Body Object Other tags of tenant_connection for the owner of network (the owner tenant of network can update this field) optional   Terminate 400

Response

Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 OK
400 Bad request
401 Unauthorized
404 Not found
409 Conflicted
500 Internal server error

Response Body

Format

{
  "tenant_connection":{
    "id": "<tenant_connection_id>",
    "tenant_connection_request_id": "<tenant_connection_request_id>",
    "name": "<name>",
    "description": "<description>",
    "tags": {},
    "tenant_id": "<tenant_id>",
    "name_other": "<name_other>",
    "description_other": "<description_other>",
    "tags_other": {},
    "tenant_id_other": "<tenant_id_other>",
    "network_id": "<network_id>",
    "device_type": "<device_type>",
    "device_id": "<device_id>",
    "device_interface_id": "<device_interface_id>",
    "port_id": "<port_id>",
    "status": "<status>"
  }
}

Parameters

Response Parameters
item format description
tenant_connection Object tenant_connection resource
id String(UUID) tenant_connection unique ID.
tenant_connection_request_id String(UUID) Name of tenant_connection_request.
name String(255) Name of tenant_connection.
description String(255) Description of tenant_connection.
tags Object Tags of tenant_connection.
tenant_id String(UUID) Tenant ID of the owner.
name_other String(255) Name for the owner of network.
description_other String(255) Description for the owner of network.
tags_other Object Tags for the owner of network.
tenant_id_other String(UUID) The owner tenant of network.
network_id String(UUID) Network unique id.
device_type String(ECL::Compute::Server, ECL::Baremetal::Server, ECL::VirtualNetworkAppliance::VSRX) device type
device_id String(UUID) device unique id.
device_interface_id String(UUID) physical port unique ID in Baremetal server.
port_id String(UUID) Port unique id.
status String(creating, deleting, active, updating, monitoring_unavailable, down, error, disconnected, inconsistent) Status of tenant_connection.

Sample Request and Response

Sample API request

Request URI

https://{api_endpoint}/v2.0/tenant_connections/{tenant_connection_id}

Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4

Request Body

{
  "tenant_connection": {
    "name": "test_name",
    "description": "test_desc",
    "tags": {
      "test_tags": "test"
    }
  }
}

Sample API response

Response Header

HTTP/1.1 200 OK

Response Body

{
  "tenant_connection": {
    "id": "ea5d975c-bd31-11e7-bcac-0050569c850d",
    "tenant_id": "c7f3a68a73e845d4ba6a42fb80fce03f",
    "tenant_id_other": "7e91b19b9baa423793ee74a8e1ff2be1",
    "tenant_connection_request_id": "90381138-b572-11e7-9391-0050569c850d",
    "network_id": "c4d5fc41-b7e8-4f19-96f4-85299e54373c",
    "device_type": "ECL::Compute::Server",
    "device_id": "7cc34d4b-a345-4e51-b3d9-62540faca7bf",
    "device_interface_id": "",
    "port_id": "c9c3de44-0720-4acd-87c1-9c76f0f77cac",
    "status": "down",
    "name": "test_name",
    "description": "test_desc",
    "tags": {
        "test_tags": "test"
    },
    "name_other": "",
    "description_other": "",
    "tags_other": {}
  }
}

Example error message

HTTP request

PUT /v2.0/tenant_connections/{tenant_connection_id} HTTP/1.1
User-Agent: curl/7.37.1
Host: 10.1.131.140
Content_type:application/json
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
Content-Length: 73
Content-Type: application/x-www-form-urlencoded

HTTP Response

HTTP/1.1 400 Bad Request
Server: nginx/1.8.0
Date: Mon, 28 Sep 2015 10:32:56 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 39
Connection: keep-alive

{
    "cause": "Invalid request body"
}