1.1. Get started¶
This API allows you to create/update/read/delete your EIC. Here you can see how to use the API to for some basic use cases.
Enterprise Cloud Interconnectivity(EIC)¶
Note¶
We use the same API endpoint and almost similar API models with CIC. So some API parameter names are the same with them.
Create mEIC¶
NTTCom will create mEIC on behalf of you. Please contact our sales of ECL1.0. We will also create the first EIC.
Create EIC¶
Once mEIC is created, you can create the second EIC by yourself!
Authentication¶
At first, please call the authentication API. You can get authentication token by following instructions on this page . In following steps, you need to put the authentication token in X-Auth-Token header of API request.
Confirm mEIC¶
Please confirm your mEIC is created first. Call the API below.:
$ curl -H "Content-Type: application/json" \
-H "X-Auth-Token: {token}" \
-X GET {api_endpoint}/v1.0/ecc/mCICs/{mcic_id}
This will return a list of your mEICs. Please note "mcic_id" to use in the following steps. If you'd like to get more detailed information, please refer show-mcic-label.
Create EIC¶
Let's create EIC resource! You can create a new EIC with this API call. You need to collect some parameters from ECL1.0 Portal.
$ curl -H "Content-Type: application/json" \
-H "X-Auth-Token: {token}" \
-d '{"network_id": "cbbafd82-8f99-4eda-9e46-97ddf24bdxxx","cic_name": "friendly name","server_segment_nbr": 1}'
-X POST {api_endpoint}/v1.0/ecc/mCICs/{mcic_id}/CICs
- This will return these 2 items.
- operation_id
- cic_id
You can use the operation_id to track your EIC creation status. See the next step for the detail. If you'd like to get more detailed information, please refer create-cic-label.
Track the EIC status¶
You can see the status of EIC creation (or deletion) with this API call.
$ curl -H "Content-Type: application/json" \
-H "X-Auth-Token: {token}" \
-X GET {api_endpoint}/v1.0/ecc/operations/{operation_id}
- This will return these items.
- operation_id
- operation_status
- operation_type
- operation_body
- mcic_id
- cic_id
- user_id
- user_name
- reciept_date
- error_messages
You will see "operation_status" as processing, success or failure. If you'd like to get more detailed information, please refer show-operation-label
Delete EIC¶
When you no longer use your EIC, you can delete your server by calling this API.
$ curl -H "Content-Type: application/json" \
-H "X-Auth-Token: {token}" \
-X DELETE {api_endpoint}/v1.0/ecc/mCICs/{mcic_id}/CICs/{cic_id}
- This will return these items.
- operation_id
- cic_id
You can use the operation_id to track your EIC deletion status which is described in 2.4.2 Track the EIC status. If you'd like to get more detailed information, please refer delete-cic-label
Delete mEIC¶
NTTCom will delete mEIC on behalf of you. Please contact our sales of ECL1.0. We will also delete the first EIC.