List mCICs¶

Summary¶

Lists contract informations of mCIC.

Type¶

List

Target object of API¶

mCIC

Synchronous/Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{api_endpoint}/v1.0/ecc/mCICs

HTTP Request Header¶

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

HTTP Request Body¶

none

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(varchar)	keystone authentication token	required		Terminate	401

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 Code¶

Response Codes¶
response code	condition
200	normal end
400	bad request
401	unauthorized
404	not found
500	internal server error

Response Body¶

Format¶

/// If service_type is "NGC-EC", this format is returned.
[{
  "mcic_id": "<mcic id>",
  "mcic_status": "<mcic status>",
  "mcic_name": "<friendly name>",
  "tenant_id": "<tenant id>",
  "tenant_name": " ",
  "service_id": "<service id>",
  "service_type": "NGC-EC",
  "ngc": {
    "dc_tag": "<dc tag>",
    "dc_name": "<dc name>",
  },
  "ec": {
    "dc_tag": "<dc tag>",
    "dc_name": "<dc name>",
  },
  "timezone": "UTC"
}]

/// If service_type is "NGC-colo", this format is returned.
[{
  "mcic_id": "<mcic id>",
  "mcic_status": "<mcic status>",
  "mcic_name": "<mcic name>",
  "tenant_id": "<tenant id>",
  "tenant_name": "<tenant name>",
  "service_type": "NGC-colo",
  "ngc": {
    "dc_tag": "<dc tag>",
    "dc_name": "<dc name>",
  },
  "colo": {
    "dc_tag": "<dc tag>",
    "dc_name": "<dc name>",
    "a_system": {
      "rack_id": "<rack id>"
    },
    "b_system": {
      "rack_id": "<rack id>"
    }
  }
  "timezone": "UTC"
}]

Parameters¶

Response Parameters¶
item	format	description
mcic_id	String	It identify mCIC uniquely
mcic_status	String	Status of mCIC. active/inactive are displayed.
mcic_name	String	mcic friendly name
tenant_id	String	It identify user tenant(project) uniquely.
tenant_name	String	Nothing is displayed.
service_id	String	ID of a service which you have in the Enterprise Cloud 1.0 and to which you would like to create a mCIC from your tenant in Smart Data Platform.
service_type	String	It show connection service type. NGC-EC/NGC-colo are displayed.
ngc	Object	This parameter is object item.
dc_tag	String	It identifies Data-center of Smart Data Platform uniquely.
dc_name	String	Data-center name of Smart Data Platform
colo	Object	This parameter is object item. When service type is selected NGC-colo, this object is displayed.
dc_tag	String	It identifies Data-center of Colocation service uniquely.
dc_name	String	Data-center name of Colocation service.
a_system	Object	This parameter is object item.
rack_id	String	It identifies your rack ID.
b_system	Object	This parameter is object item.
rack_id	String	It identifies your rack ID.
ec	Object	This parameter is object item. When service type is selected NGC-EC, this object is displayed.
dc_tag	String	It identifies Data-center tag of Enterprise Cloud 1.0 uniquely.
dc_name	String	Data-center name of Enterprise Cloud 1.0
timezone	String	This parameter is fixed UTC.

Sample Request and Response¶

Sample API request¶

Request URI¶

http://{api_endpoint}/v1.0/ecc/mCICs

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.
[{
  "mcic_id": "CLC-JP-00000000",
  "mcic_status": "active",
  "mcic_name": "mCIC friendly name",
  "tenant_id": "28606dde52cd465eaa566aa42981dc70",
  "tenant_name": " ",
  "service_id": "SID-JP-00022828",
  "service_type": "NGC-EC",
  "ngc": {
    "dc_tag": "YKH1.ngc",
    "dc_name": "Yokohama#1[NGC JPN]",
  },
  "ec": {
    "dc_tag": "YKH1",
    "dc_name": "Yokohama#1[Enterprise Cloud 1.0 JPN]",
  },
  "timezone": "UTC"
}]

/// If service_type is "NGC-colo", this format is returned.
[{
  "mcic_id": "CIC-JP-A0000000",
  "mcic_status": "active",
  "mcic_name": "mCIC friendly name"
  "tenant_id": "28606dde52cd465eaa566aa42981dc70",
  "tenant_name": " ",
  "service_type": "NGC-colo"
  "ngc": {
    "dc_tag": "YKH1.ngc",
    "dc_name": "Yokohama#1[NGC JPN]",
  },
  "colo": {
    "dc_tag": "YKH1.colo",
    "dc_name": "Yokohama#1[Colo JPN]",
    "a_system": {
      "rack_id": "1A0509ｷ"
    },
    "b_system": {
      "rack_id": "2B0512"
    }
  }
  "timezone": "UTC"
}]

Example error message¶

HTTP request¶

GET /v1.0/ecc/mCICs 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:4e54395a12b740d585d74190ba4eb14c

HTTP Response¶

HTTP/1.1 500 HTTP 500: Internal Server Error
Server: nginx/1.8.0
Date: Mon, 28 Sep 2015 10:25:31 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 40
Connection: keep-alive

{
  "cause": "Internal Server Error"
}

4.1. mCIC

Show mCICs