List CICs¶
Summary¶
Lists contract informations of CIC.
Type¶
- List
Target object of API¶
- CIC
Synchronous/Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{api_endpoint}/v1.0/ecc/mCICs/{mcic_id}/CICs
HTTP Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>
HTTP Request Body¶
- none
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 | |
| mcic_id | URL | String(15) | It identifies mCIC uniquely. | 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
- skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"
Response Body¶
Format¶
/// If service_type is "NGC-EC", this format is returned.
[{
"cic_id": "<cic ID>",
"cic_name": "<cic friendly name>",
"cic_status": "<cic status>",
"network_id": "<network ID>",
"network_name": "<network name>",
"server_segment_nbr": <server segment number>,
"server_segment_name": "<server segment name>"
"bandwidth": <bandwidth>
}]
/// If service_type is "NGC-colo", this format is returned.
[{
"cic_id": "<cic ID>",
"cic_name": "<cic friendly name>",
"cic_status": "<cic status>",
"network_id": "<network ID>",
"network_name": "<network name>",
"destination_vlan": <user vlan>,
"bandwidth": <bandwidth>
}]
Parameters¶
| item | format | description |
| cic_id | String | It identifies CIC uniquely. |
| cic_name | String | CIC friendly name. |
| cic_status | String | Status of CIC. initiate/active/inactive are displayed. |
| network_id | String | It identifies network in Smart Data Platform uniquely. |
| network_name | String | Network name in Smart Data Platform. |
| server_segment_nbr | Int | Available server segment number of Enterprise Cloud 1.0. server segment number is form 1 to 24. If service_type is NGC-EC this parameter returns. |
| server_segment_name | String | Available server segment name of Enterprise Cloud 1.0. If service_type is NGC-EC this parameter returns. |
| destination_vlan | Int | User vlan. If service_type is NGC-colo this parameter returns. |
| bandwidth | Int | Bandwidth of CIC. 0/1000 are displayed. |
Sample Request and Response¶
Sample API request¶
Request URI¶
http://{api_endpoint}/v1.0/ecc/mCICs/CLC-JP-00000001/CICs
http://{api_endpoint}/v1.0/ecc/mCICs/CIC-JP-A0000001/CICs
Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4
Request Body¶
- none
Sample API response¶
Response Header¶
HTTP/1.1 200 OK
<response_code>: see "HTTP Responses" section
<message>: message based on the response code
- skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"
Response Body¶
/// If service_type is "NGC-EC", this format is returned.
[{
"cic_id": "CLC-JP-00000001-0001",
"cic_name": "CIC friendly name",
"cic_status": "active",
"network_id": "xxx",
"network_name": "xxx",
"destination_vlan": 1500,
"bandwidth": 1000
}]
/// If service_type is "NGC-colo", this format is returned.
[{
"cic_id": "CIC-JP-A0000001-0001",
"cic_name": "CIC friendly name",
"cic_status": "active",
"network_id": "xxx",
"network_name": "xxx",
"server_segment_nbr": 1,
"server_segment_name": "name"
"bandwidth": 1000
}]
Example error message¶
HTTP request¶
GET /v1.0/ecc/mCICs/CIC-JP-A0000000/CICs HTTP/1.1
User-Agent: curl/7.37.1
Host: 192.168.150.71:9001
Content_type:application/json
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
HTTP Response¶
HTTP/1.1 404 HTTP 404: Not Found
Server: nginx/1.8.0
Date: Mon, 28 Sep 2015 10:24:37 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 56
Connection: keep-alive
{
"cause": "Could not found mCIC. CIC-JP-A0000000"
}