Add CloudConnectorPrivate

POST 
https://api.orange.com/evolutionplatform/aws/api/v1//projects/:projectId/aws/cloudconnectors/privates

This operation allows to add a CloudConnectorPrivate

Request

Path Parameters

projectId uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

project Id

application/json

Body

CloudConnectorPrivate to create

namestringrequired
cloud connector name
Possible values: Value must match regular expression \S
Default value: name-of-your-CC
statestringrequired
cloud connector state
Possible values: [DESIGNING, DESIGNED, PROVISIONING, STOPPING, SUSPENDING, REPAIRING, ACTIVE, INACTIVE, ERROR, TERMINATED]
bandwidthint32required
cloud connector bandwidth
Default value: 50
maxBandwidthint32
cloud connector maximum bandwidth
Default value: 100
technicalVpnIduuidrequired
network connector uuid associated with the cloud connector
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
awsCredentialIduuidrequired
aws credential uuid to be used to manage the cloud connector on aws
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
virtualInterfaceTypestringrequired
cloud connector virtual interface type
Possible values: [privateVif, transitVif]
Default value: privateVif
locationstringrequired
cloud connector location
Possible values: Value must match regular expression \S
Default value: name-of-the-interconnection-orange-with-aws
regionstring
cloud connector region
Default value: region-of-your-customerGateway
customerGatewayIdstringrequired
customer gateway id
Possible values: Value must match regular expression \S
Default value: 3e429df0-6fb4-4473-acc1-e5688209bec2
routingPolicystring
cloud connector routing policy
Possible values: [basicAggregate, defaultRoute, noAggregate]
Default value: basicAggregate

Responses

201

created

Response Headers

Content-Location

cloud connector id

application/json

Schema

Schema

iduuid
cloud connector id
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
namestring
cloud connector name
Default value: name-of-your-CC
statestring
cloud connector state
Possible values: [DESIGNING, DESIGNED, PROVISIONING, STOPPING, SUSPENDING, REPAIRING, ACTIVE, INACTIVE, ERROR, TERMINATED]
bandwidthint32
cloud connector bandwidth
Default value: 50
maxBandwidthint32
cloud connector maximum bandwidth
Default value: 100
technicalVpnIduuid
network connector uuid associated with the cloud connector
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
awsCredentialIduuid
aws credential uuid to be used to manage the cloud connector on aws
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
virtualInterfaceTypestring
cloud connector virtual interface type
Possible values: [privateVif, transitVif]
Default value: privateVif
locationstring
cloud connector Orange location
Default value: name-of-the-interconnection-orange-with-aws
regionstring
cloud connector AWS region
Default value: region-of-your-customerGateway
customerGatewayIdstring
customer gateway id
Default value: 3e429df0-6fb4-4473-acc1-e5688209bec2
routingPolicystring
cloud connector routing policy
Possible values: [basicAggregate, defaultRoute, noAggregate]
operationalStatusstring
operational status of the cloud connector
Possible values: [N/A, Up, Down, Unknown]
workflowExecutionIduuid
uuid of the last workflow execution associated with the cloud connector
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
workflowExecutionStatusstring
status of the last workflow execution associated with the cloud connector
Possible values: [CREATED, IN_PROGRESS, SUCCEEDED, FAILED, CLEARED]
Default value: SUCCEEDED

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "name-of-your-CC",
  "state": "DESIGNING",
  "bandwidth": 50,
  "maxBandwidth": 100,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "awsCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "virtualInterfaceType": "privateVif",
  "location": "name-of-the-interconnection-orange-with-aws",
  "region": "region-of-your-customerGateway",
  "customerGatewayId": "3e429df0-6fb4-4473-acc1-e5688209bec2",
  "routingPolicy": "basicAggregate",
  "operationalStatus": "N/A",
  "workflowExecutionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflowExecutionStatus": "SUCCEEDED"
}

400

bad request

application/json

Schema

Schema

codeint32
bad request code
messagestring
bad request message
descriptionstring
bad request description
violations object[]
bad request violations
Array [
fieldstring
field
messagestring
message
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

unauthorized access

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

forbidden access

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

internal error

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

Authorization: http

name: SecuritySchemetype: httpdescription: Authenticationscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L 'https://api.orange.com/evolutionplatform/aws/api/v1//projects/:projectId/aws/cloudconnectors/privates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "name": "name-of-your-CC",
  "state": "DESIGNING",
  "bandwidth": 50,
  "maxBandwidth": 100,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "awsCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "virtualInterfaceType": "privateVif",
  "location": "name-of-the-interconnection-orange-with-aws",
  "region": "region-of-your-customerGateway",
  "customerGatewayId": "3e429df0-6fb4-4473-acc1-e5688209bec2",
  "routingPolicy": "basicAggregate"
}'

Request Collapse all

Base URL

https://api.orange.com/evolutionplatform/aws/api/v1/

Auth

Bearer Token

Parameters

projectId — pathrequired

Body

{
  "name": "name-of-your-CC",
  "state": "DESIGNING",
  "bandwidth": 50,
  "maxBandwidth": 100,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "awsCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "virtualInterfaceType": "privateVif",
  "location": "name-of-the-interconnection-orange-with-aws",
  "region": "region-of-your-customerGateway",
  "customerGatewayId": "3e429df0-6fb4-4473-acc1-e5688209bec2",
  "routingPolicy": "basicAggregate"
}