Find answers on InterCloud Portal and APIs
The Portal allows the creation of users with specific roles, in a standard RBAC model. Users identify on the Portal with a login and Password.\nTwo roles are defined by default:\n \u0026quot;admin\u0026quot; role, that allows all operations, including the creation, modification and deletion of new users of the organization the account was created in, and its children organizations;\n \u0026quot;user\u0026quot; role, with only read access to the organization the account was created in and its children organizations.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/access_management\/" }, { value: "Introduction", label: "
InterCloud\u0027s Portal allows the clients under InterCloud\u0026rsquo;s \u0026quot;Connector model\u0026quot; to view and retrieve monitoring information on the different standard elements constituting InterCloud\u0027s offer. These elements include Cloud appliances, Groups, Connectors, and Links.\nThe Portal is accessible through HTTPS on https:\/\/console.intercloud.io\/.\nInterCloud develops the Portal with an API first approach. The client can retrieve every information displayed by the Portal through InterCloud\u0027s APIs.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/introduction\/" }, { value: "KPIs", label: "
Different KPIs are available throughout the Portal. For Connectors and Cloud Virtual Interfaces, it is the Output and Input bitrates. For Links, it is the Latency, Jitter, and Packet Loss.\nKPIs are measured every 5 minutes. Networks KPIs are retained for 1 year.\nEvery graphic is displayed the same way. The user accessing the graphics may export the KPIs in image or data format and inspect the KPIs for a specified period.\nExporting KPIs To export the Connector\u0027s KPIs in Image (PNG, JPG, PDF) or Data (JSON, CSV, XLSX) format, move the mouse over the \u0026quot;Export\u0026quot; button on the bottom right of a graphic, the select Image or Data, and then the desired file format.\nChanging the period By default, graphics are displayed for the \u0026quot;Last day\u0026quot;. To select another period, click on the \u0026quot;Last day\u0026quot; button, on the top right corner, and select the appropriate period. Then choose between:\n Last day\n Last week\n Last month\n Last 90 days\n Or a Custom period with the date picker.\n Then click outside of the date picker. The graphics refresh to the specified period.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/kpis\/" }, { value: "User Manual", label: "
", url:"\/user-manual\/" }, { value: "REST API Reference Documentation", label: "
The InterCloud REST API documentation is available in a Swagger UI online version\nThe InterCloud REST API is avaiblable in a OpenAPI Version 2 format\n", url:"\/rest-api\/" }, { value: "Cloud appliance details", label: "
When clicking on a Connector in a Connectors list, the user accesses the Connector details.\nThe top menu allows the user to access the following Connector information:\n KPIs:\n Output bitrate of the Connector;\n Input bitrate of the Connector;\n Status:\n BGP session status, i.e., whether the edge is up (OK) or down (KO);\n Edge status, whether the edge is up (OK) or down (KO);\n Config: the parameters of the Connectors\n General parameters\n Name, the name of the Connector\n Description, the description of the Connector\n InterCloud region, the region this Connector belongs to\n SLA city, the city relevant to the Service Level Agreements\n Cloud destination parameters\n Name, the Cloud Service Provider region full name\n Family, the Cloud Service Provider name\n Region, the Cloud Service Provider region\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/cloud-appliance\/cloud-appliance-details\/" }, { value: "Cloud Virtual Interfaces", label: "
Clicking on the Cloud Virtual Interfaces opens the details for every interface on the Cloud Appliance, allowing the user to see their KPIs and status.\nThe top menu allows the user to retrieve the following information:\n KPIs: the KPIs of the Cloud Virtual Interface\n Input bitrate\n Output bitrate\n Status\n Status of the Cloud Appliance the Cloud Virtual Interface is on (\u0026quot;OK\u0026quot; for up or \u0026quot;KO\u0026quot; for down) Config: the Configuration of the Cloud Appliance\n Name, the name of the Cloud Appliance (e.g., \u0026quot;Cloud Appliance Madrid\u0026quot;)\n Cloud Appliance model, the model of the device for the Cloud Appliance (e.g., \u0026quot;SRX340\u0026quot;)\n Management IP, the management IP of the Cloud Appliance, if available;\n Hostname, the hostname of the Cloud Appliance (e.g., \u0026quot;cpe1.mgmt.demo.fr-dem.intercloud.fr\u0026quot;);\n Site name, the site name of the Cloud Appliance (e.g., \u0026quot;Madrid\u0026quot;)\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/cloud-appliance\/cloud-appliance-vif\/" }, { value: "Requirements", label: "
Chrome Browser (85\u002b) with Javascript enabled Edge Browser (85\u002b) with Javascript enabled Safari Browser (13.1.2\u002b) with Javascript enabled Firefox Browser (80\u002b) with Javascript enabled
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/requirements\/" }, { value: "API How-tos", label: "
", url:"\/api-howtos\/" }, { value: "1. Groups Metrics", label: "
How to retrieve Groups Metrics ? Get Group IRN The request route to get the groups list is:\nGET \/groups It provides a response which lists all groups with individual information:\n[ { \u0026#34;id\u0026#34;: \u0026#34;3247aade-d579-48cd-9459-ed818b5a0525\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2019-03-08T15:23:29.701293Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2019-03-08T15:23:29.701293Z\u0026#34;, \u0026#34;irn\u0026#34;: \u0026#34;irn:group:7b2e43bc4892::oyel09\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;Group\u0026#34;, \u0026#34;description\u0026#34;: \u0026#34;k\u0026#34;, \u0026#34;organisationId\u0026#34;: \u0026#34;11007c0f-1cea-418c-a7bd-7b2e43bc4892\u0026#34;, \u0026#34;allocatedCapacity\u0026#34;: null, \u0026#34;tagIds\u0026#34;: null, \u0026#34;countConnectors\u0026#34;: 1, \u0026#34;countLinks\u0026#34;: 0 } ] The IRN can be found in the key irn: \u0026quot;irn:group:7b2e43bc4892::oyel09\u0026quot;\nGet Group Metrics The following request list all available metrics for a group:\nGET \/metrics\/query\/irn\/irn:group:7b2e43bc4892::oyel09 The response is:\n[ { \u0026#34;name\u0026#34;: \u0026#34;latin-america\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;japan\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;south-africa\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;southeast-asia\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;north-america\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;europe\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;pacific\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; } ] Regional Used Capacity All the metrics available for a group provide the used capacity in a given region. There are currently 7 regions in InterCloud service offer.\nRun Group Metrics The request to run a capacity metric is:\nGET \/metrics\/query\/irn\/irn:group:1jeqjrcewkrkg::3tznx1\/europe\/run?start-d=2019-03-11T13:15:47%2B01:00\u0026amp;end-d=2019-03-18T13:15:47%2B01:00 The response is:\n{ \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34;, \u0026#34;measure\u0026#34;: \u0026#34;Capacity\u0026#34;, \u0026#34;axis\u0026#34;: { \u0026#34;non_negative_derivative\u0026#34;: { \u0026#34;unit\u0026#34;: \u0026#34;Bytes\/s\u0026#34;, \u0026#34;title\u0026#34;: \u0026#34;\u0026#34; } }, \u0026#34;Results\u0026#34;: [ { \u0026#34;Series\u0026#34;: [ { \u0026#34;name\u0026#34;: \u0026#34;interface_snmp\u0026#34;, \u0026#34;columns\u0026#34;: [ \u0026#34;time\u0026#34;, \u0026#34;sum\u0026#34; ], \u0026#34;values\u0026#34;: [ [ \u0026#34;1970-01-01T00:00:00Z\u0026#34;, 437.8840402443454 ] ] } ], \u0026#34;Messages\u0026#34;: null } ] }
api
rest
user
manual
metrics
introduction
groups", url:"\/api-howtos\/metrics\/2.1-groups-metrics\/" }, { value: "Authentication", label: "
api
rest
user
manual
authentication
token", url:"\/api-howtos\/authentication\/" }, { value: "Get an Access Token", label: "
The first operation to be performed before being able to access to the API is authentication.\nThe user shall be registered on the portal. See your administrator to get an account.\nSee Authentication section of the API reference for detail information.\nThe end user has to call the POST \/auth\/token endpoint to create a access token.\nSee Token section for API reference on this call.\n\u0008For example:\ncurl \u0026#39;https:\/\/api-console-lab.intercloud.io\/auth\/token\u0026#39; \\ -X POST \\ -H \u0026#39;authorization: Basic MTIzNDphYWJiY2NkZA==\u0026#39; \\ -H \u0026#39;Content-type: application\/json\u0026#39; \\ --data \u0026#39;{ \u0026#34;grant_type\u0026#34;: \u0026#34;password\u0026#34;, \u0026#34;password\u0026#34;: \u0026#34;horse bottle sidecar computer\u0026#34;, \u0026#34;scope\u0026#34;: \u0026#34;everything\u0026#34;, \u0026#34;username\u0026#34;: \u0026#34;[email protected]\u0026#34; }\u0026#39; Note: grant_type shall always be equal to \u0026ldquo;password\u0026rdquo;, scope shall always be equal to \u0026ldquo;everything\u0026rdquo;\n The API provides an access token if user is registered:\n{ \u0026#34;access_token\u0026#34;: \u0026#34;XS12zK1pTMS8VegiHkcvtA\u0026#34;, \u0026#34;expires_in\u0026#34;: 3600, \u0026#34;refresh_token\u0026#34;: \u0026#34;8oBxvcomQVK3yEywJI8akQ\u0026#34;, \u0026#34;scope\u0026#34;: \u0026#34;everything\u0026#34;, \u0026#34;token_type\u0026#34;: \u0026#34;Bearer\u0026#34; } The access token is supposed to be provided in an Authorization header in every request to grant access to the API.\nExample for curl calls:\n-H \u0026#34;Authorization: Bearer XS12zK1pTMS8VegiHkcvtA\u0026#34;
api
rest
user
manual
access
token", url:"\/api-howtos\/authentication\/access-token\/" }, { value: "Site map", label: "
The Portal is organized with the following page hierarchy:\n Groups (Landing page)\n Connectors\n KPIs\n Status\n Config\n Links\n KPIs Allocated Capacity\n Cloud appliances\n Cloud virtual interfaces\n KPIs Users\n Sub-organizations\n User menu\n Terms of service\n Legal mentions\n Account settings\n Organization settings\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/site-map\/" }, { value: "How to log in", label: "
Open the Chrome browser to https:\/\/console.intercloud.io\/\nEnter the email address of the account in the \u0026quot;Email\u0026quot; address field, and the Password in the \u0026quot;Password\u0026quot; field, then click on \u0026quot;Sign in\u0026quot;.\nThe user can reset his Password by clicking underneath the form on \u0026quot;Forgot your password?\u0026quot; and following the instructions on \u0026quot;Resetting your password\u0026quot;.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/logging-in\/" }, { value: "List of groups", label: "
The user can access the list of Groups page by clicking on \u0026quot;Groups\u0026quot; in the left blue panel. The list of Groups page is also the landing page after login.\nOn the top of the page, on the right of the \u0026quot;Manage your Groups\u0026quot; header, the logged user can choose between two views of his Groups:\n a list view, listing the Groups\u0027 names with their number of Connectors and Links;\n a world view, displaying all the Groups and their Connectors on a map at their geographical location.\n List view Inside the list view, the user sees all the Groups defined in his InterCloud\u0027s cloud network environment, with their number of Connectors and Links. By clicking on a Group, the user can access its content.\nWhen hovering over a Group as a user with \u0026quot;admin\u0026quot; privileges, the settings menu appears. If the user clicks on \u0026quot;Settings\u0026quot;, a popup appears. The user may then edit the name of the Group, its description, and its tags.\nMap view Inside the map view, the user views the Connectors, drawn as yellow circles. Their position on the map corresponds to the geographical position of the datacenter in which they are configured. Moving the mouse over a Connector, displayed as a yellow circle, displays its name in a tooltip.\nLinks between the connectors are displayed with gray lines connecting them.\nThe user may decide to show or hide Groups by clicking the checkboxes on the top right corner.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/groups\/" }, { value: "The group page", label: "
When clicking on a Group in the \u0026quot;List of Groups\u0026quot; page, a user accesses a Group and its content. A Group contains:\n Connectors\n Links\n An allocated capacity\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/group\/" }, { value: "Inter-region GW", label: "
The list of available Inter-region Gateway are displayed when the Inter-region GW is selected in the left panel.\nFor each Inter-region Gateway, the following information are provided:\n Name, the name of the Inter-region Gateway\n Regions, the two InterCloud regions linked by the Inter-region Gateway, i.e., EU - Europe, JAP - Japan, LATAM - Latin America, NORAM - North America, PAC - Pacific, SE ASIA - South East Asia\n Edge1, the location of the Inter-region Edge (IRE)\n Edge 2, the location of the other Inter-region Edge\n Subscribed Bandwidth (Mbps), the bandwidth subscribed for this Inter-region Gateway\n Used bandwidth (Mbps), the average used bandwidth for the past 7 days\n Status, the status of the Inter-region Gateway, i.e., OK if available, NOK if not available\n
portal
user
manual
connector
inter-region
gateway
edge
bandwidth
irgw", url:"\/user-manual\/inter-region_gw\/" }, { value: "Inter-region GW details", label: "
When clicking the Inter-region Gateway in the Inter-Gateway list, the user accesses the Inter-region Gateway details.\nThe following information are available:\n Bandwidth\n Subscribed bandwidth Used bandwidth A pie chart of the subscribed bandwidth versus average used bandwidth KPIs\n Bandwidth Latency Jitter Packet loss The duration of the reported KPIs can be selected (Last 7 days, Last month, Last 3 months) IRE details - details of each IRE\n Region, the InterCloud region City, the city where the IRE is deployed Edge, the InterCloud Edge ID Hostname Interface Description BGP Description Linked Connectors, the list of Connectors linked to this IRE
portal
user
manual
connector
inter-region
inter-region GW
inter-region edges
inter-region edges
inter-region bandwidth
irgw", url:"\/user-manual\/inter-region_gw\/inter-region_gw-details\/" }, { value: "List of cloud appliances", label: "
When clicking on a Cloud Appliance, the user opens a Cloud Appliance details page, showing the created Cloud Virtual Interfaces details.\nThe Cloud Virtual Interfaces details provide the following information:\n The name of the Cloud Virtual Interface (e.g., \u0026quot;CVI-Mad-1\u0026quot;)\n The tags associated, beneath the name (e.g., \u0026quot;Madrid_site\u0026quot;)\n The status of the Cloud Appliance (e.g., \u0026quot;OK\u0026quot;)\n If the user clicks on a specific Cloud Virtual Interface, the Cloud Virtual Interface details page opens.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/cloud-appliance\/" }, { value: "List of connectors", label: "
To access the list of Connectors of a Group, click on \u0026quot;Groups\u0026quot;, on the left blue panel. Select the Group in the list, then click on \u0026quot;Connectors\u0026quot; in the left gray panel.\nThe list of Connectors displays all the Connectors of the Group, along with:\n Their name (e.g., \u0026quot;CSP AWS Dublin\u0026quot;);\n Their Connector family: either the Cloud Service Provider\u0027s name (e.g., \u0026quot;Amazon Web Services\u0026quot;) or \u0026quot;Enterprise\u0026quot;, for enterprise Connectors;\n Their Cloud destination\/Appliance: either the Cloud Service Provider\u0027s on-ramp or the Cloud Appliance;\n Their Status: whether the Connector state is \u0026quot;OK\u0026quot; or \u0026quot;KO\u0026quot;. The status of a Connector is a composite value. In essence, it is a logical conjunction between the Connector\u0027s BGP session status and the Connector\u0027s Edge availability status.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/group\/connectors\/" }, { value: "Users list", label: "
The users\u0027 list displays the following tabs:\n Logo, an automatically generated picture to quickly identify a User;\n Name, the full name (first name and last name) of a User;\n Email, the email address set up for the user;\n Role, the role of the user. Two default roles exist:\n admin\n users\n Actions, with a recycle bin logo, to delete a User.\n When clicking on a given user, a User profile page opens.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/users\/users-list\/" }, { value: "Linked Connectors List", label: "
When clicking Linked Connectors in Inter-region Gateway Details, the list of Connectors linked to the selected IRE is displayed.\nFor each Connector, the following information are available:\n Name, the name of the Connector\n Family, the Cloud Service Provider name\n Destination, the Cloud Service Provider on-ramp location\n Group, the name of the Group where this Connector belongs\n Status, the BGP status of this Connector, i.e., whether the edge is up (OK) or down (KO)\n
portal
user
manual
connector
inter-region
inter-region GW
inter-region edges
inter-region edges
inter-region bandwidth
irgw", url:"\/user-manual\/inter-region_gw\/linked_connectors_list\/" }, { value: "Connector details", label: "
When clicking on a Connector in a Connectors list, the user accesses the Connector details.\nThe top menu allows the user to access the following Connector information:\n Life-cycle: when the connector was registered, started being deployed and was deployed;\n KPIs:\n Output bitrate of the Connector;\n Input bitrate of the Connector;\n Note: Some Cloud Service Providers, such as Azure, enforce two connections for redundancy at the peering location. In that case, the Output and Input bitrates for both connections are available.\n Status:\n BGP session status, i.e., whether the edge is up (OK) or down (KO);\n Edge status, whether the edge is up (OK) or down (KO);\n Config: the parameters of the Connectors\n General parameters\n Name, the name of the Connector\n Description, the description of the Connector\n InterCloud region, the region this Connector belongs to\n SLA city, the city relevant to the Service Level Agreements\n Cloud destination parameters\n Name, the Cloud Service Provider region full name\n Family, the Cloud Service Provider name\n Region, the Cloud Service Provider region\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/group\/connector-details\/" }, { value: "Users", label: "
A logged user can access the list of the Users of an Organization by clicking on \u0026quot;Users\u0026quot; in the left blue panel. The user is then presented with:\n A Panel, with the Company address (this information is editable through the Organization settings of the User\u0027s menu);\n A button to \u0026quot;add a User\u0026quot;;\n The ability to search, view, and edit the Users list.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/users\/" }, { value: "Connector deployment", label: "
The user must be of role \u0026ldquo;admin\u0026rdquo;. When in a Group page, click on the menu \u0026ldquo;Register a connector\u0026rdquo;.\nSet the relevant information:\n Name: InterCloud\u0026rsquo;s name for the connector (e.g., \u0026ldquo;AWS Connector\u0026rdquo;)\n Description: a description for this connector (e.g., \u0026ldquo;Dublin\u0026rdquo;)\n Tags: the tags (e.g., \u0026ldquo;Production\u0026rdquo;)\n Connector family: the Cloud Service Provider to use (e.g., \u0026ldquo;Amazon Web Services\u0026rdquo;)\n Cloud destination: the on-ramp (e.g., \u0026ldquo;AWS Eircom Clonslaugh, Dublin, IRL\u0026rdquo;)\n Then click on next. Provide then InterCloud with the relevant Cloud Service Provider technical information. Depending on the Cloud Service Provider and the connectivity model, the required information may change:\nFor AWS, in the \u0026ldquo;hosted vif\u0026rdquo; model:\n AWS account ID, the account to offer the \u0026ldquo;hosted vif\u0026rdquo; to;\n AS Number: the BGP AS number of the virtual environment.\n Public access: whether the resource accessed is public or private.\n Click submit. Then click Start deployment.\nIn a matter of minutes, the connector is then deployed on InterCloud\u0026rsquo;s infrastructure.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/group\/connector-deployment\/" }, { value: "Reset the password", label: "
To reset the password of an account, the client must:\n Open the Chrome Browser on https:\/\/console.intercloud.io\/reset-password\n Enter the email address used to set up the account in the \u0026quot;Email\u0026quot; field\n Click on \u0026quot;Reset password\u0026quot;. An email is sent to the specified account, with a link to open to set up a new password.\n Open the link specified in the email\n Enter in the \u0026quot;Password\u0026quot; and \u0026quot;Confirm password\u0026quot; fields the new password for the account. A strength assessment is performed on the password.\n Click on Submit\n The Password is modified. The user is then automatically logged in.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/reset-password\/" }, { value: "Sub-organizations", label: "
When clicking on \u0026ldquo;Sub-organizations\u0026rdquo; the logged user sees the list of the sub-organizations of its organization. A sub-organization is a way for an organization to logically segregate connectivity resources between entities (business units, subsidiaries, client organizations\u0026hellip;)\nAn \u0026ldquo;admin\u0026rdquo; user may create any number of sub-organizations for his organization, and create specific users for these sub-organizations.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/sub-organizations\/" }, { value: "Personal menu", label: "
If the user clicks at the bottom on the left blue panel, the Personal Menu appears. The personal menu allows to access:\n The Terms of services, situated at https:\/\/intercloud.com\/cgu\/\n The Legal mentions, situated at https:\/\/intercloud.com\/legal-mentions\/\n The Account settings, that when accessed, display three sub-menus:\n Profile, to display and modify this user\u0027s profile (first name, last name, email)\n Password, to update the Password\n Personal access tokens, to create machine-to-machine tokens for the API\n The Organization settings, with two sub-menus:\n Information, to view and modify the user\u0026rsquo;s organization name and address and phone number\n Subscribed Capacity, to view the Capacity bought by the user\u0026rsquo;s organization for each InterCloud region\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/personal-menu\/" }, { value: "2. Connectors Metrics", label: "
How to retrieve Connectors Metrics ? Get Connector IRN The request route to get the connectors list is:\nGET \/connectors It provides a response which lists all connectors with individual information:\n[ { \u0026#34;id\u0026#34;: \u0026#34;e011088b-b41c-4486-b3b7-2a86a9c4136d\u0026#34;, \u0026#34;connectorType\u0026#34;: \u0026#34;virtualGateway\u0026#34;, \u0026#34;connectorTypeId\u0026#34;: \u0026#34;81467636-c6c2-45c1-9689-d56fafb8f3be\u0026#34;, \u0026#34;irn\u0026#34;: \u0026#34;irn:connectors:1hv0g4w1k2rkg::swzehj\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;VRF-CST-INTERCLOUD-012--AZURE-16\u0026#34;, \u0026#34;description\u0026#34;: \u0026#34;VRF-CST-INTERCLOUD-012--AZURE-16\u0026#34;, \u0026#34;tagIds\u0026#34;: null, \u0026#34;organisationId\u0026#34;: \u0026#34;81a88c9d-d94d-41e1-a4b6-3e9ebbb3a822\u0026#34;, \u0026#34;groupId\u0026#34;: \u0026#34;80ae7ebc-11a3-4d91-a905-5bc2435bbbe9\u0026#34;, \u0026#34;region\u0026#34;: \u0026#34;Europe\u0026#34;, \u0026#34;slug\u0026#34;: \u0026#34;europe\u0026#34;, \u0026#34;longitude\u0026#34;: 2.3506622, \u0026#34;latitude\u0026#34;: 48.9269417, \u0026#34;routerIrn\u0026#34;: \u0026#34;irn:geoentrypoint:1hv0g4w1k2rkg::swza2k\u0026#34;, \u0026#34;bgpDescriptions\u0026#34;: [ \u0026#34;CST-INTERCLOUD-012-AZURE-BGP-CPE-DC2-PRIMARY\u0026#34; ], \u0026#34;routerInterface\u0026#34;: [ \u0026#34;CST:INTERCLOUD::MX-DC2:XE-0\/1\/0::INTERCLOUD-012:AZURE:PRIMARY\u0026#34; ] } ] The IRN can be found in the key irn: \u0026quot;irn:connectors:1hv0g4w1k2rkg::swzehj\u0026quot;\nGet Connector Metrics The following request list all available metrics for a group:\nGET \/metrics\/query\/irn\/irn:connectors:1hv0g4w1k2rkg::swzehj The response is:\n[ { \u0026#34;name\u0026#34;: \u0026#34;bits_send\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;bits_received\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;connStatusHistory\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;connStatus\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;status\u0026#34; } ] bit_sends : is the input bandwidth for this connector bit_received : is the output bandwidth for this connector connStatus : is the last known BGP sessions status for this connector connStatusHistory: is the history of the BGP sessions status for this connector (number of measure points Up and Down per day) Run Connector Metrics The request to run a status metric, for example, is:\nGET \/metrics\/query\/irn\/irn:connectors:1hv0g4w1k2rkg::swzehj\/connStatus\/run?start-d=2019-03-11T13:15:47%2B01:00\u0026amp;end-d=2019-03-18T13:15:47%2B01:00 The response is (status metric type):\n{ \u0026#34;type\u0026#34;: \u0026#34;JSONSchemeForConnectors\u0026#34;, \u0026#34;results\u0026#34;: [ { \u0026#34;data\u0026#34;: { \u0026#34;bgpName\u0026#34;: \u0026#34;BGP peer - CST-INTERCLOUD-002-AZURE-AMSTERDAM-PARIS-SECONDARY\u0026#34;, \u0026#34;bgpStatus\u0026#34;: 0, \u0026#34;hostName\u0026#34;: \u0026#34;hostname.intercloud.fr\u0026#34;, \u0026#34;hostStatus\u0026#34;: 0 } }, { \u0026#34;data\u0026#34;: { \u0026#34;bgpName\u0026#34;: \u0026#34;BGP peer - CST-INTERCLOUD-002-AZURE-AMSTERDAM-PARIS-PRIMARY\u0026#34;, \u0026#34;bgpStatus\u0026#34;: 0, \u0026#34;hostName\u0026#34;: \u0026#34;hostname.intercloud.fr\u0026#34;, \u0026#34;hostStatus\u0026#34;: 0 } } ] }
api
rest
user
manual
metrics
introduction
connectors", url:"\/api-howtos\/metrics\/2.2-connectors-metrics\/" }, { value: "Get a Personnal Access Token", label: "
In order to simplify access to InterCloud resource, users can create personal access tokens.\nThese tokens have configurable expiration time and can be revoked by users thanks to the REST API.\nOnce a user has received an access token, he can create a personal access token with the following curl call:\ncurl \u0026#39;https:\/\/api-console-lab.intercloud.io\/personal\/tokens\u0026#39; \\ -H \u0026#39;authorization: Bearer 15rvofFMSr6-7vf60LCRwg\u0026#39; \\ -H \u0026#39;content-type: application\/json\u0026#39; \\ --data-binary \u0026#39;{ \u0026#34;name\u0026#34;:\u0026#34;personal token\u0026#34;, \u0026#34;comment\u0026#34;:\u0026#34;Jenkins Token\u0026#34;, \u0026#34;scope\u0026#34;:\u0026#34;everything\u0026#34;, \u0026#34;expiresIn\u0026#34;:65535 }\u0026#39; { \u0026#34;access_token\u0026#34;:\u0026#34;jU1pnEAeRtaxlesHGD_nlg\u0026#34;, \u0026#34;expires_in\u0026#34;:65535, \u0026#34;scope\u0026#34;:\u0026#34;everything\u0026#34;, \u0026#34;token_type\u0026#34;:\u0026#34;Bearer\u0026#34; } The new access token can be used in any request in the Authorization header:\n-H \u0026#34;Authorization: Bearer jU1pnEAeRtaxlesHGD_nlg\u0026#34;
api
rest
user
manual
personal
access
token", url:"\/api-howtos\/authentication\/personal-access-token\/" }, { value: "Introduction to Metrics", label: "
Introduction to InterCloud Portal Metrics What is a Metric ? The metrics API endpoint objective is to provide a way to require metrics or KPIs from different monitoring back-ends, without having to deal with their request formats.\nThe metrics API endpoint is organized from the measured resources.\nThe process is:\n get the monitored resource unique InterCloud identifiant (IRN, see next section) get the list of available metrics for this resource run the metric to retrieve data What is an IRN ? IRN stands for InterCloud Resource Name.\nAn IRN is an unique identifier (string format) that helps in a specific resource identification.\nIt gathers the resource family information, the resource owner and a unique identifier.\nPlease find below an example of IRN:\nirn:geoentrypoint:1hv0g4w1k2rkg::t2cxj9 What are the available Metric Types ? The InterCloud portal provides 2 types of measurements:\n timeseries: this type of metric provides a list of measures with timestamps (example: input or output bandwidth of a connector, measurement of the jitter) status: this type of metric provides a specific status of a resource (example: BGP session is up or down) There are several different measurement metrics for each type of metrics.\nHow to Run a Metric ? The request format to run a specific metric is:\nGET \/metrics\/query\/irn\/\u0026lt;irn\u0026gt;\/latency\/run?start-d=\u0026lt;s_timestamp\u0026gt;\u0026amp;end-d=\u0026lt;e_timestamp\u0026gt; The parameters are:\n \u0026lt;irn\u0026gt;: this is the IRN value of the monitored resource \u0026lt;s_timestamp\u0026gt;: this is a timestamp to start the monitoring scale \u0026lt;e_timestamp\u0026gt;: this is a timestamp to end the monitoring scale Example:\nGET \/metrics\/query\/irn\/irn:links:1jeqjrcewkrkg::3u217p\/latency\/run?start-d=2019-03-17T12:03:01%2B01:00\u0026amp;end-d=2019-03-18T12:03:01%2B01:00
api
rest
user
manual
metrics
introduction", url:"\/api-howtos\/metrics\/" }, { value: "User profile", label: "
The user profile\u0027s page displays:\n Lastname;\n Firstname;\n Email, the login email address of the user;\n Role, the role. One of two default roles:\n admin\n user\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/users\/user-profile\/" }, { value: "3. Links Metrics", label: "
How to retrieve Links Metrics ? Get Links IRN The request route to get the links list for a given group is:\nGET \/link\/group\/3247aade-d579-48cd-9459-ed818b5a0525 It provides a response which lists all links with individual information:\n[ { \u0026#34;id\u0026#34;: \u0026#34;4b9c6c3d-37e0-421a-a1e1-1d1be84e8ec9\u0026#34;, \u0026#34;created_at\u0026#34;: \u0026#34;2019-03-11 08:22:41.387672 \u002b0000 UTC\u0026#34;, \u0026#34;updated_at\u0026#34;: \u0026#34;2019-03-11 08:22:41.387672 \u002b0000 UTC\u0026#34;, \u0026#34;irn\u0026#34;: \u0026#34;irn:links:urejt82ajhco::1tfjjjn\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;LINK-INTERCLOUD-DUBLIN-AWS\u0026#34;, \u0026#34;description\u0026#34;: \u0026#34;LINK-INTERCLOUD-DUBLIN-AWS\u0026#34;, \u0026#34;tagIds\u0026#34;: null, \u0026#34;from\u0026#34;: \u0026#34;389bf518-beac-4a8f-b33c-98b2f0220258\u0026#34;, \u0026#34;to\u0026#34;: \u0026#34;f4f85588-82c5-40be-9adf-de758ff816e8\u0026#34; }, { \u0026#34;id\u0026#34;: \u0026#34;77a5c058-cbe2-4604-a59d-b3861489432a\u0026#34;, \u0026#34;created_at\u0026#34;: \u0026#34;2019-03-11 08:22:41.66323 \u002b0000 UTC\u0026#34;, \u0026#34;updated_at\u0026#34;: \u0026#34;2019-03-11 08:22:41.66323 \u002b0000 UTC\u0026#34;, \u0026#34;irn\u0026#34;: \u0026#34;irn:links:urejt82ajhco::1tfine9\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;LINK-INTERCLOUD-AMSTERDAM-AZURE\u0026#34;, \u0026#34;description\u0026#34;: \u0026#34;LINK-INTERCLOUD-AMSTERDAM-AZURE\u0026#34;, \u0026#34;tagIds\u0026#34;: null, \u0026#34;from\u0026#34;: \u0026#34;4b168282-f36b-4b28-9a67-189d934d06c1\u0026#34;, \u0026#34;to\u0026#34;: \u0026#34;f4f85588-82c5-40be-9adf-de758ff816e8\u0026#34; } ] Get Link Metrics The following request list all available metrics for a link:\nGET \/metrics\/query\/irn\/irn:links:skstok62tbks::1s2w551 The response looks like:\n[ { \u0026#34;name\u0026#34;: \u0026#34;latency\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;packet_loss\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;jitter\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; } ] latency : delay that happens over a link packet_loss : number of lost packet over a time period over a given link jitter : variance in time delay that happens over a link Run Link Metrics The request to run a status metric, for example, is:\nGET \/metrics\/query\/irn\/irn:links:1hv0g4w1k2rkg::1s2w551\/latency\/run?start-d=2019-03-11T13:15:47%2B01:00\u0026amp;end-d=2019-03-18T13:15:47%2B01:00 The response is (timeseries metric type):\n{ \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34;, \u0026#34;measure\u0026#34;: \u0026#34;Latency\u0026#34;, \u0026#34;axis\u0026#34;: { \u0026#34;mean\u0026#34;: { \u0026#34;unit\u0026#34;: \u0026#34;ms\u0026#34;, \u0026#34;title\u0026#34;: \u0026#34;\u0026#34; } }, \u0026#34;Results\u0026#34;: [ { \u0026#34;Series\u0026#34;: [ { \u0026#34;name\u0026#34;: \u0026#34;ping_sondes\u0026#34;, \u0026#34;columns\u0026#34;: [ \u0026#34;time\u0026#34;, \u0026#34;mean\u0026#34; ], \u0026#34;values\u0026#34;: [ [ \u0026#34;2019-03-20T12:20:00Z\u0026#34;, 13.546 ], [ \u0026#34;2019-03-20T12:25:00Z\u0026#34;, 13.562800000000001 ], [ \u0026#34;2019-03-20T12:30:00Z\u0026#34;, 13.5782 ], ...
api
rest
user
manual
metrics
introduction
links", url:"\/api-howtos\/metrics\/2.3-links-metrics\/" }, { value: "Collect all used capacities by region.", label: "
The current InterCloud API provides routes to retrieve your groups\u0026rsquo; used capacity per region.\nIf you are an InterCloud services reseller, you may want to retrieve all capacities, across all your children\u0026rsquo;s groups.\nThis document is a step-by-step guide to doing that using our current API.\nThe procedure can be summed up as:\n Retrieve current user organization ID Retrieve child organization IDs For every child organization, List all Groups belonging to an organization Collect regional capacity for each group Authentication : Generate a Bearer access token Authentication to the API is done via a Bearer access token. Your application can generate a 1-hour access token as explained below. You can also use a Personal Access Token, more suitable for one-off users (scripts, etc.)\nThe generated token shall then be included in all of your request headers.\nGenerate a Personal Access Token You can generate and manage Personal Access Tokens via theAccount Settings section of InterCloud Portal. These tokens have configurable expiration time. This type of token is best for on-off usages (scripts, etc.)\nGenerate an API access token (one hour validity) If you\u0026rsquo;re developing a full application, you might prefer to use programatically generated tokens. These tokens expire after one hours\u0026rsquo; time.\nTo create an access token the user needs to have an account into the InterCloud Console. The following endpoint needs to be used:\nPOST \/auth\/token Headers:\n-H \u0026#34;Content-Type:application\/json\u0026#34; -H \u0026#39;authorization:Basic \u0026lt;basic_token\u0026gt;\u0026#39; \u0026lt;basic_token\u0026gt; will be provided on-demand by InterCloud\nBody:\n{ \u0026#34;grant_type\u0026#34;: \u0026#34;password\u0026#34;, \u0026#34;password\u0026#34;: \u0026#34;titi tata toto\u0026#34;, \u0026#34;scope\u0026#34;: \u0026#34;everything\u0026#34;, \u0026#34;username\u0026#34;: \u0026#34;[email protected]\u0026#34; } username: user account username\npassword: user account password\nResponse:\n{ \u0026#34;access_token\u0026#34;: \u0026#34;wYMd38feTwSDoekqi251Eg\u0026#34;, \u0026#34;expires_in\u0026#34;: 3600, \u0026#34;refresh_token\u0026#34;: \u0026#34;aEji5l66QhW7rsb8_IM0vQ\u0026#34;, \u0026#34;scope\u0026#34;: \u0026#34;everything\u0026#34;, \u0026#34;token_type\u0026#34;: \u0026#34;Bearer\u0026#34; } access_token: access token\nexpires_in: expiration period in seconds\nRetrieving organization information Retrieve all your organization IDs The current user organization id can be retrieved using the following call:\nGET \/me\/info Headers:\n-H \u0026#39;authorization:Bearer \u0026lt;personal_access_token\u0026gt;\u0026#39; The response gives detailed information of the current user:\n{ \u0026#34;id\u0026#34;: \u0026#34;70876bdc-eb28-427d-94d7-30fb384ae7d6\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2020-06-26T10:23:26.672563Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2020-06-26T10:23:50.369896Z\u0026#34;, \u0026#34;lastname\u0026#34;: \u0026#34;test\u0026#34;, \u0026#34;firstname\u0026#34;: \u0026#34;test\u0026#34;, \u0026#34;email\u0026#34;: \u0026#34;[email protected]\u0026#34;, \u0026#34;role\u0026#34;: \u0026#34;admin\u0026#34;, \u0026#34;contact\u0026#34;: null, \u0026#34;preference\u0026#34;: null, \u0026#34;login\u0026#34;: { \u0026#34;id\u0026#34;: \u0026#34;f67574d0-57c1-4220-9174-f0cc09f3bd11\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2020-06-26T10:26:05.655184Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2020-06-26T11:59:36.679991Z\u0026#34;, \u0026#34;userId\u0026#34;: \u0026#34;70876bdc-eb28-427d-94d7-30fb384ae7d6\u0026#34;, \u0026#34;firstLoginAt\u0026#34;: \u0026#34;2020-06-26T10:26:05.562083Z\u0026#34;, \u0026#34;numberLogin\u0026#34;: 3, \u0026#34;numberFaileLogin\u0026#34;: 0, \u0026#34;lastLoginAt\u0026#34;: \u0026#34;2020-06-26T11:59:36.554576Z\u0026#34;, \u0026#34;lastFailedLoginAt\u0026#34;: \u0026#34;0001-01-01T00:00:00Z\u0026#34;, \u0026#34;userAgentFirstLogin\u0026#34;: \u0026#34;Go-http-client\/1.1\u0026#34;, \u0026#34;ipFirstLogin\u0026#34;: \u0026#34;\u0026#34; }, \u0026#34;organisationId\u0026#34;: \u0026#34;a9910752-3a6b-44db-88b0-ac558614ac99\u0026#34; } Use the current user\u0026rsquo;s organisation ID to retrieve all of your children\u0026rsquo;s IDs in the following request:\nGET \/organisations\/\u0026lt;organisationID\u0026gt; Headers:\n-H \u0026#39;authorization:Bearer \u0026lt;personal_access_token\u0026gt;\u0026#39; The response gives a list of all children organizations and the current organization details:\n{ \u0026#34;id\u0026#34;: \u0026#34;a9910752-3a6b-44db-88b0-ac558614ac99\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;Parent orga\u0026#34;, \u0026#34;address\u0026#34;: { \u0026#34;id\u0026#34;: \u0026#34;009d5c97-7105-4fe9-a856-b3504491f757\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2020-06-26T09:52:20.215053Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2020-06-26T09:52:20.215053Z\u0026#34;, \u0026#34;organisationId\u0026#34;: \u0026#34;a9910752-3a6b-44db-88b0-ac558614ac99\u0026#34;, \u0026#34;street\u0026#34;: \u0026#34;d\u0026#34;, \u0026#34;city\u0026#34;: \u0026#34;d\u0026#34;, \u0026#34;zipcode\u0026#34;: \u0026#34;d\u0026#34;, \u0026#34;country\u0026#34;: \u0026#34;d\u0026#34; }, \u0026#34;capacities\u0026#34;: null, \u0026#34;invoice\u0026#34;: { \u0026#34;id\u0026#34;: \u0026#34;7b900b35-b681-467e-87ca-c953f0860ef2\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2020-06-26T09:52:20.216173Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2020-06-26T09:52:20.216173Z\u0026#34;, \u0026#34;organisationId\u0026#34;: \u0026#34;a9910752-3a6b-44db-88b0-ac558614ac99\u0026#34;, \u0026#34;tvasubjection\u0026#34;: false, \u0026#34;tvanumber\u0026#34;: \u0026#34;\u0026#34;, \u0026#34;tvaintra\u0026#34;: \u0026#34;\u0026#34; }, \u0026#34;phone\u0026#34;: \u0026#34;d\u0026#34;, \u0026#34;parentId\u0026#34;: \u0026#34;11007c0f-1cea-418c-a7bd-7b2e43bc4892\u0026#34;, \u0026#34;children\u0026#34;: [ { \u0026#34;id\u0026#34;: \u0026#34;2b8214f2-0142-43ed-872d-b39cdf4c1255\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;Sub-orga 1\u0026#34;, \u0026#34;reseller\u0026#34;: false, \u0026#34;childrenCount\u0026#34;: 0 }, { \u0026#34;id\u0026#34;: \u0026#34;643c72b8-275d-4e60-8931-bdaca3877e56\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;Sub-orga 2\u0026#34;, \u0026#34;reseller\u0026#34;: false, \u0026#34;childrenCount\u0026#34;: 0 } ], \u0026#34;reseller\u0026#34;: true } Accessing a child organization\u0026rsquo;s resources If your organization is a reseller of InterCloud services, you\u0026rsquo;ll be able to access your child organization\u0026rsquo;s resources by adding the InterCloud-Scope header to your requests.\nIf this header is omitted, you\u0026rsquo;ll be viewing your own resources. Examples are given in the next section.\nList all Groups belonging to an organization The Groups list can be retrieved by using the simple endpoint:\nGET \/groups Headers:\n-H \u0026#39;authorization:Bearer \u0026lt;personal_access_token\u0026gt;\u0026#39; Used without any particular header, this call returns the current organization group list.\nIn order to list the Groups of a child organization, the Intercloud-Scope header must be added to the request\n-H \u0026#34;intercloud-scope:\u0026lt;parent_organization_ID\u0026gt;\u0026#34; \u0026lt;parent_organization_ID\u0026gt; must be replaced by the organizationID retreived by me\/info\nResponse looks like:\n{ \u0026#34;id\u0026#34;: \u0026#34;65d641e3-adcc-489f-b1e9-f4997d25ad75\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2020-06-26T10:02:22.996745Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2020-06-26T10:02:22.996745Z\u0026#34;, \u0026#34;irn\u0026#34;: \u0026#34;irn:group:b39cdf4c1255::16d2xtw\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;Europe 2\u0026#34;, \u0026#34;description\u0026#34;: \u0026#34;\u0026#34;, \u0026#34;organisationId\u0026#34;: \u0026#34;2b8214f2-0142-43ed-872d-b39cdf4c1255\u0026#34;, \u0026#34;allocatedCapacity\u0026#34;: null, \u0026#34;tagIds\u0026#34;: null, \u0026#34;countConnectors\u0026#34;: 1, \u0026#34;countFlowConnectors\u0026#34;: 0, \u0026#34;countLinks\u0026#34;: 0, \u0026#34;countFlowLinks\u0026#34;: 0 } The irn of this group will be used to collect metrics such as used capacity.\nIntroduction to InterCloud Portal Metrics What is a Metric ? The metrics API endpoint provides a way to query metrics or KPIs from different monitoring back-ends, without having to deal with their request formats.\nThe metrics API endpoint is organized by resource.\nThe process is:\n Retrieve the resource\u0026rsquo;s unique InterCloud ID (IRN, see next section) Get the list of available metrics for this resource Run (ie. query) the metric to retrieve data What is an IRN ? IRN stands for InterCloud Resource Name.\nAn IRN is a string that uniquely identifies an InterCloud resource. It gathers the resource family information, the resource owner and a unique identifier.\nPlease find below an example of IRN:\nirn:geoentrypoint:1hv0g4w1k2rkg::t2cxj9 What are the available Metric Types ? The InterCloud portal provides 2 types of measurements:\n timeseries: This type of metric provides a list of measures with timestamps (example: input or output bandwidth of a connector, measurement of the jitter) status: This type of metric provides a specific status of a resource (example: BGP session is up or down) There are several different measurement metrics for each type of metrics.\nHow to run a Metric ? In InterCloud\u0026rsquo;s terminology, running a metric means performing a query with the desired parameters (for, eg. start\/end dates, etc).\nThe request format to run a specific metric is:\nGET \/metrics\/query\/irn\/\u0026lt;irn\u0026gt;\/\u0026lt;metric_type\u0026gt;\/run?start-d=\u0026lt;s_timestamp\u0026gt;\u0026amp;end-d=\u0026lt;e_timestamp\u0026gt; The parameters are:\n \u0026lt;irn\u0026gt;: this is the IRN value of the monitored resource \u0026lt;metric_type\u0026gt;: the metric to collect \u0026lt;s_timestamp\u0026gt;: this is a timestamp to start the monitoring scale \u0026lt;e_timestamp\u0026gt;: this is a timestamp to end the monitoring scale Example:\nGET \/metrics\/query\/irn\/irn:links:1jeqjrcewkrkg::3u217p\/latency\/run?start-d=2019-03-17T12:03:01%2B01:00\u0026amp;end-d=2019-03-18T12:03:01%2B01:00 List available group metrics : Regional Used Capacity The following request list all available metrics for a group:\nGET \/metrics\/query\/irn\/\u0026lt;group_irn\u0026gt; \u0026lt;group_irn\u0026gt; must be replaced by the targeted group\u0026rsquo;s IRN, retrieved with GET \/groups\nIf the targeted organization isn\u0026rsquo;t the one of the current user, the InterCloud-Scope header is mandatory.\n-H \u0026#39;authorization:Bearer \u0026lt;personal_access_token\u0026gt;\u0026#39; -H \u0026#34;InterCloud-Scope: \u0026lt;parent_organization_ID\u0026gt;\u0026#34; \nThe response is:\n[ { \u0026#34;name\u0026#34;: \u0026#34;latin-america\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;japan\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;south-africa\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;southeast-asia\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;north-america\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;europe\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;pacific\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; } ] All the metrics listed in the response above provide the used capacity in a given region. There are currently 7 regions in InterCloud\u0026rsquo;s service offer.\nQuery group metrics The \/run query described above can be used as follows to retrieve a group\u0026rsquo;s used capacity.\nGET \/metrics\/query\/irn\/\u0026lt;irn\u0026gt;\/\u0026lt;metric_type\u0026gt;\/run?start-d=\u0026lt;s_timestamp\u0026gt;\u0026amp;end-d=\u0026lt;e_timestamp\u0026gt; Possible values for metric_type are: europe, japan, latin-america, north-america, pacific, south-africa,southeast-asia.\nHeaders:\n-H \u0026#39;authorization:Bearer \u0026lt;personal_access_token\u0026gt;\u0026#39; -H \u0026#34;intercloud-scope:\u0026lt;parent_organization_ID\u0026gt;\u0026#34; \nHere\u0026rsquo;s what the response looks like:\n{ \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34;, \u0026#34;measure\u0026#34;: \u0026#34;Used Capacity\u0026#34;, \u0026#34;axis\u0026#34;: { \u0026#34;non_negative_derivative\u0026#34;: { \u0026#34;unit\u0026#34;: \u0026#34;bps\u0026#34;, \u0026#34;title\u0026#34;: \u0026#34;\u0026#34; } }, \u0026#34;Results\u0026#34;: [ { \u0026#34;Series\u0026#34;: [ { \u0026#34;name\u0026#34;: \u0026#34;interface_snmp\u0026#34;, \u0026#34;columns\u0026#34;: [ \u0026#34;time\u0026#34;, \u0026#34;sum\u0026#34; ], \u0026#34;values\u0026#34;: [ [ \u0026#34;2020-06-24T12:30:00Z\u0026#34;, 355.37333333333333 ], [ \u0026#34;2020-06-24T12:35:00Z\u0026#34;, 389.58666666666664 ], [ \u0026#34;2020-06-24T12:40:00Z\u0026#34;, 3637.6222222391766 ], [ \u0026#34;2020-06-24T12:45:00Z\u0026#34;, 26894.48444442749 ], [ \u0026#34;2020-06-24T12:50:00Z\u0026#34;, 14125.12444442749 ], [ \u0026#34;2020-06-24T12:55:00Z\u0026#34;, 2812.2222222391765 ] ] } ], \u0026#34;Messages\u0026#34;: null } ] } Data points are stored in bps every 5 minutes. The preferred time interval for the request is one day, above this value data is aggregated.\nIf the metric request is done on the exact same time period over all Groups, received timestamps will be aligned and easier to aggregate.\n InterCloud July 2020 *
", url:"\/api-howtos\/collect-used-capa\/" }, { value: "Allocated capacity", label: "
Each Group has an Allocated Capacity that is a fraction of the total Subscribed Capacity by the client. To view the Allocated Capacity of a Group, and its usage, click on the left gray panel on \u0026quot;Allocated Capacity\u0026quot;.\nThe following informations will be displayed:\n Region (e.g., \u0026quot;Europe\u0026quot;), the InterCloud region of the Allocated Capacity;\n Allocated Capacity (e.g., \u0026quot;0.10Gb\u0026quot;), the Capacity in Gbps, attributed to the Group;\n Used Capacity (e.g., \u0026quot;9.21Mb\u0026quot;), the Capacity for the last 7 days;\n Capacity usage (e.g., \u0026quot;9.21 %\u0026quot;), the ratio of used Capacity by allocated Capacity.\n To view the used Capacity, click on the Capacity.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/group\/allocated-capacity\/" }, { value: "Changing a password", label: "
When clicking on \u0026quot;Password\u0026quot; in the left gray panel of a user profile, a panel appears, with the rules for a new password. To change the Password click the gear icon on the top right corner. To modify a user\u0027s Password, the logged user must have the role \u0026quot;admin\u0026quot;.\nA popup appears. Enter the new Password in the \u0026quot;New Password\u0026quot; and \u0026quot;Confirm new password\u0026quot; fields. A strength assessment is performed on the Password. Then click \u0026quot;Submit\u0026quot;.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/users\/changing-password\/" }, { value: "List of links", label: "
To access the list of Links of a Group, click on \u0026quot;Groups\u0026quot;, in the left blue panel. Select the Group in the list, then click on \u0026quot;Links\u0026quot; in the left gray panel.\nThe list of Links displays all the Links of the Group, along with:\n Their name (e.g., \u0026quot;London to AWS Frankfurt\u0026quot;) ;\n Their tags (e.g., \u0026quot;AWS\u0026quot;, \u0026quot;Frankfurt\u0026quot;, \u0026quot;London_Site\u0026quot;), underneath the name;\n Their source Connector (\u0026quot;From\u0026quot;, e.g., \u0026quot;CSP AWS Frankfurt\u0026quot;) and destination Connector (\u0026quot;To\u0026quot;, e.g., \u0026quot;Ent London DC\u0026quot;).\n To access the Links KPIs, click on a Link.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/group\/links\/" }, { value: "Link KPIs", label: "
The Links KPIs are:\n Latency;\n Jitter;\n Packet loss.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/group\/link-details\/" }, { value: "4. Cloud Virtual Interfaces Metrics", label: "
How to retrieve Cloud Virtual Interfaces Metrics ? Get Cloud Appliance ID The request route to get the cloud appliance ID:\nGET \/cloud-appliances It provides a response which lists all cloud appliances (CPE) with individual information:\n[ { \u0026#34;id\u0026#34;: \u0026#34;0344bcae-b37d-4646-a4cc-434400a6f81e\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2019-03-20T10:20:53.107684Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2019-03-20T10:20:53.107684Z\u0026#34;, \u0026#34;irn\u0026#34;: \u0026#34;irn:cpe:skstok62tbks::1rjn9qx\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;TEST\u0026#34;, \u0026#34;description\u0026#34;: \u0026#34;This Cloud Appliance is dedicated to check data consistency after version upgrade\u0026#34;, \u0026#34;tagIds\u0026#34;: [ \u0026#34;cde88161-a9a9-46b0-b4ae-4da7a0918b21\u0026#34;, \u0026#34;b81d85e6-59da-4bc5-988e-41dc5eab10ac\u0026#34;, \u0026#34;ac9ea0ad-90d6-4a80-b7f9-948b68c07d4e\u0026#34;, \u0026#34;976119e3-95ac-4a40-901c-63f397ece834\u0026#34; ], \u0026#34;cloudApplianceModel\u0026#34;: { \u0026#34;id\u0026#34;: \u0026#34;725eb82e-0053-40e0-98a7-0558facd4bd3\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2018-08-20T11:58:34.361307Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2018-08-20T11:58:34.361307Z\u0026#34;, \u0026#34;modelName\u0026#34;: \u0026#34;SRX1500\u0026#34;, \u0026#34;maxCapacity\u0026#34;: \u0026#34;Up to 5G\u0026#34;, \u0026#34;connectorsNumber\u0026#34;: 0, \u0026#34;dualPowered\u0026#34;: false, \u0026#34;flowtypes\u0026#34;: \u0026#34;\u0026#34;, \u0026#34;vendor\u0026#34;: \u0026#34;Juniper\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;Standard\u0026#34;, \u0026#34;uplinkMedia\u0026#34;: \u0026#34;10GBase-LR\u0026#34; }, \u0026#34;cloudApplianceModelID\u0026#34;: \u0026#34;725eb82e-0053-40e0-98a7-0558facd4bd3\u0026#34;, ... \u0026#34;cloudVirtualInterfaces\u0026#34;: [ { \u0026#34;id\u0026#34;: \u0026#34;5cb99193-af86-496c-b5ab-beba6aa9833b\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2019-03-20T10:21:40.542528Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2019-03-20T10:21:40.542528Z\u0026#34;, \u0026#34;cloudApplianceId\u0026#34;: \u0026#34;0344bcae-b37d-4646-a4cc-434400a6f81e\u0026#34;, \u0026#34;irn\u0026#34;: \u0026#34;irn:cloudgateway:skstok62tbks:entreprise:1rlgnex\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;TEST \u0026#34;, \u0026#34;tagIds\u0026#34;: [ \u0026#34;cde88161-a9a9-46b0-b4ae-4da7a0918b21\u0026#34;, \u0026#34;b81d85e6-59da-4bc5-988e-41dc5eab10ac\u0026#34;, \u0026#34;976119e3-95ac-4a40-901c-63f397ece834\u0026#34;, \u0026#34;ac9ea0ad-90d6-4a80-b7f9-948b68c07d4e\u0026#34; ], \u0026#34;description\u0026#34;: \u0026#34;This Cloud Virtual Interface is dedicated to check data consistency after version upgrade\u0026#34;, \u0026#34;cmeIfDescription\u0026#34;: \u0026#34;CST:L3-CONNECTOR-INTERCLOUD-001-CLOUD-SERVICES\u0026#34;, \u0026#34;organisationId\u0026#34;: \u0026#34;11007c0f-1cea-418c-a7bd-7b2e43bc4892\u0026#34;, ... Get Cloud Virtual Interface IRN The IRN of the cloud virtual interfaces are embedded in the previous response:\n\u0026#34;cloudVirtualInterfaces\u0026#34;: [ { \u0026#34;id\u0026#34;: \u0026#34;5cb99193-af86-496c-b5ab-beba6aa9833b\u0026#34;, \u0026#34;createdAt\u0026#34;: \u0026#34;2019-03-20T10:21:40.542528Z\u0026#34;, \u0026#34;updatedAt\u0026#34;: \u0026#34;2019-03-20T10:21:40.542528Z\u0026#34;, \u0026#34;cloudApplianceId\u0026#34;: \u0026#34;0344bcae-b37d-4646-a4cc-434400a6f81e\u0026#34;, \u0026#34;irn\u0026#34;: \u0026#34;irn:cloudgateway:skstok62tbks:entreprise:1rlgnex\u0026#34;, \u0026#34;name\u0026#34;: \u0026#34;TEST \u0026#34;, \u0026#34;tagIds\u0026#34;: [ \u0026#34;cde88161-a9a9-46b0-b4ae-4da7a0918b21\u0026#34;, \u0026#34;b81d85e6-59da-4bc5-988e-41dc5eab10ac\u0026#34;, \u0026#34;976119e3-95ac-4a40-901c-63f397ece834\u0026#34;, \u0026#34;ac9ea0ad-90d6-4a80-b7f9-948b68c07d4e\u0026#34; ], \u0026#34;description\u0026#34;: \u0026#34;This Cloud Virtual Interface is dedicated to check data consistency after version upgrade\u0026#34;, \u0026#34;cmeIfDescription\u0026#34;: \u0026#34;CST:L3-CONNECTOR-INTERCLOUD-001-CLOUD-SERVICES\u0026#34;, \u0026#34;organisationId\u0026#34;: \u0026#34;11007c0f-1cea-418c-a7bd-7b2e43bc4892\u0026#34;, ... Get Cloud Virtual Interface Metrics The request to list all metrics for a cloud virtual interface is:\nGET \/metrics\/query\/irn\/irn:cloudgateway:skstok62tbks:entreprise:1rlgnex The answer is:\n[ { \u0026#34;name\u0026#34;: \u0026#34;vgwStatus\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;status\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;bits_send\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; }, { \u0026#34;name\u0026#34;: \u0026#34;bits_received\u0026#34;, \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34; } ] bits_send : incoming bandwidth bits_received : outgoing bandwidth vgwStatus : status of the cloud virtual interface Run Cloud Virtual Interface Metrics The request to run a bits_send metric, for example, is:\n\/metrics\/query\/irn\/irn:cloudgateway:skstok62tbks:entreprise:1rlgnex\/bits_send\/run?start-d=2019-03-20T13:35:06%2B01:00\u0026amp;end-d=2019-03-21T13:35:06%2B01:00 The response is (timeseries metric type):\n{ \u0026#34;type\u0026#34;: \u0026#34;timeserie\u0026#34;, \u0026#34;measure\u0026#34;: \u0026#34;Output Bitrate\u0026#34;, \u0026#34;axis\u0026#34;: { \u0026#34;non_negative_derivative\u0026#34;: { \u0026#34;unit\u0026#34;: \u0026#34;bps\u0026#34;, \u0026#34;title\u0026#34;: \u0026#34;\u0026#34; } }, \u0026#34;Results\u0026#34;: [ { \u0026#34;Series\u0026#34;: [ { \u0026#34;name\u0026#34;: \u0026#34;interface_snmp\u0026#34;, \u0026#34;columns\u0026#34;: [ \u0026#34;time\u0026#34;, \u0026#34;non_negative_derivative\u0026#34; ], \u0026#34;values\u0026#34;: [ [ \u0026#34;2019-03-20T12:40:00Z\u0026#34;, 803.76 ], [ \u0026#34;2019-03-20T12:45:00Z\u0026#34;, 826.7733333333333 ], [ \u0026#34;2019-03-20T12:50:00Z\u0026#34;, 806.7466666666667 ],
api
rest
user
manual
metrics
introduction
cloud virtual interfaces
cvi", url:"\/api-howtos\/metrics\/2.4-cvi-metrics\/" }, { value: "Add a user", label: "
To add a user, in the Users list, click on the top right corner on \u0026quot;Add a User\u0026quot;. To be able to add a User, the logged user must have the role \u0026quot;admin\u0026quot;.\nThe user then has to specify:\n The first name;\n The last name;\n The email address, used for login;\n The role, between:\n Admin\n user\n And click \u0026quot;Create\u0026quot;. An email is then sent to the created user at the specified email address with a link to finish the creation of the account by setting up a password.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/users\/add-user\/" }, { value: "Creating a sub-organization", label: "
To create a sub-organization, in the Organizations list click on the top right corner on \u0026quot;Add an Organization\u0026quot;. To be able to create an Organization, the logged user must have the role \u0026quot;admin\u0026quot;.\nThe user then has to specify:\n The name of the organization;\n Phone number of this organization;\n Address, City, Zipcode and Country\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/sub-organizations\/create-suborganization\/" }, { value: "Switching scope to a sub-organization", label: "
When managing multiple sub-organization, to switch the actual scope to the sub-organization, click on the top left corner on the horizontal arrows, situated on the right of the name of the organization. An overlay appears, showing all the sub-organization the logged user is able to swith to.\n
portal
user
manual
connector
group
link
capacity
organization
sub-organization", url:"\/user-manual\/sub-organizations\/switch-scope\/" }, { value: "InterCloud Knowledge Base", label: "
", url:"\/" }, { value: "Categories", label: "
", url:"\/categories\/" }, { value: "Frequently Asked Questions", label: "
What is the InterCloud platform? How can I create an account on InterCloud platform? What can I do if I lost or forgot my password? What kind of token should I use to request the REST API directly? Is there any documentation and support? ? ? ? ? ", url:"\/faq\/" }, { value: "Got Any Questions", label: "
Submit the form and confirm your email address at Formspree.\n", url:"\/contact\/" }, { value: "Tags", label: "
", url:"\/tags\/" }, ]; $( "#search" ).autocomplete({ source: projects }) .data( "ui-autocomplete" )._renderItem = function( ul, item ) { return $( "
Fill the contact form, and our team will answer you soon.
contact us