Show tenant_connection_request¶
Summary¶
Show tenant_connection_request resource for Tenant Connection.
Type¶
- Show
Target object of API¶
- tenant_connection_request
Synchronous/Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{api_endpoint}/v2.0/tenant_connection_requests/{tenant_connection_request_id}
HTTP Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>
HTTP Request Body¶
Format¶
No items.
Parameters¶
name | style | format | description | required/optional | default value | action for invalid parameter | response code for invalid parameter |
---|---|---|---|---|---|---|---|
token_id | Header | authentication token string(varchar) | keystone authentication token | required | Terminate | 401 | |
tenant_connection_request_id | URL | String(UUID) | tenant_connection_request unique ID. | required | Terminate | 404 |
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 Body¶
Format¶
{
"tenant_connection_request":{
"id": "<tenant_connection_request_id>",
"status": "<status>",
"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>",
"approval_request_id": "<approval_request_id>"
}
}
Parameters¶
item | format | description |
tenant_connection_request | Object | tenant_connection_request resource |
id | String(UUID) | tenant_connection_request unique ID. |
status | String(registered, approved, denied, cancelled, unavailable) | Status of tenant_connection_request. |
name | String(255) | Name of tenant_connection_request. |
description | String(255) | Description of tenant_connection_request. |
tags | Object | Tags of tenant_connection_request. |
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. |
approval_request_id | String(UUID) | SSS approval_request ID |
Sample Request and Response¶
Sample API request¶
Request URI¶
https://{api_endpoint}/v2.0/tenant_connection_requests/{tenant_connection_request_id}
Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4
Request Body¶
No items.
Sample API response¶
Response Header¶
HTTP/1.1 200 OK
Response Body¶
{
"tenant_connection_request": {
"id": "90381138-b572-11e7-9391-0050569c850d",
"name": "",
"description": "",
"tags": {},
"tenant_id": "c7f3a68a73e845d4ba6a42fb80fce03f",
"name_other": "",
"description_other": "",
"tags_other": {},
"tenant_id_other": "7e91b19b9baa423793ee74a8e1ff2be1",
"network_id": "c4d5fc41-b7e8-4f19-96f4-85299e54373c",
"status": "approved",
"approval_request_id": "req0000010363"
}
}
Example error message¶
HTTP request¶
GET /v2.0/tenant_connection_requests/{tenant_connection_request_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"
}