Creating a PLAS Connector¶
Function¶
This API is used to create a PLAS connector. Based on the URL returned, you can query the creation progress.
URI¶
URI format
POST /v1.0/plasconnector/connectors
Parameter description
None
Request¶
Parameter description
Parameter
Mandatory
Type
Description
PlasConnectorService
Yes
PlasConnectorCreateReq object
Indicates information about the PLAS connector.
The PlasConnectorCreateReq object has the following attributes.
Parameter | Mandatory | Type | Description |
---|---|---|---|
connector | Yes | PlasConnectorBaseModel object | Indicates the request for creating a PLAS connector. |
The PlasConnectorBaseModel object has the following attributes.
Parameter | Mandatory | Type | Description |
---|---|---|---|
name | Yes | String | Indicates the PLAS Connector name. The name can consist of letters, digits, underscores (_), and hyphens (-). The value is a string of 1 to 64 characters. |
description | No | String | Indicates the PLAS Connector description. The value is a string of 0 to 255 characters. |
bandwidth | Yes | int32 | Indicates the bandwidth in Mbit/s. Value range:
|
cloudInfo | Yes | CloudInfo object | Indicates the cloud interconnected with the PLAS connector. |
networkInfo | Yes | NetworkInfo object | Indicates the network interconnected with the PLAS connector. |
The CloudInfo object has the following attributes.
Parameter | Mandatory | Type | Description |
---|---|---|---|
provider | Yes | String | Indicates the cloud provider. Only OTC is currently supported. The value is a string of 1 to 64 characters. |
masterLocation | Yes | String | Indicates the primary area that the PCCE in the PLAS Connector connects to. This area corresponds to the area of the PLGW in the cloud. Only Biere and Magdeburg are currently supported. The value is a string of 1 to 128 characters. |
masterDirectConnectId | Yes | String | Indicates the ID of the Direct Connect link connected to the primary area. The value is a string of 1 to 36 characters. |
slaveLocation | Yes | String | Indicates the secondary area that the PCCE connects to. Only Biere and Magdeburg are currently supported. The value is a string of 1 to 128 characters. |
slaveDirectConnectId | Yes | String | Indicates the ID of the Direct Connect link connected to the secondary area. The value is a string of 1 to 36 characters. |
The NetworkInfo object has the following attributes.
Parameter | Mandatory | Type | Description |
---|---|---|---|
provider | Yes | String | Indicates the network provider. Only Telekom is currently supported. The value is a string of 1 to 64 characters. |
networkDomain | Yes | String | Indicates the network domain. Only IPLS is currently supported. The value is a string of 1 to 128 characters. |
masterLocation | Yes | String | Indicates the primary area that the PCCE in the PLAS Connector connects to. This area corresponds to the area of the PLGW in the cloud. Only Biere and Magdeburg are currently supported. The value is a string of 1 to 128 characters. |
slaveLocation | Yes | String | Indicates the secondary area that the PCCE in the PLAS Connector connects to. This area corresponds to the area of the PLGW in the cloud. Only Biere and Magdeburg are currently supported. The value is a string of 1 to 128 characters. |
lineId | No | String | Indicates the line ID, which is assigned by the CCR. The value is a string of 1 to 36 characters. |
popLocation | Yes | String | Indicates the PoP that the PCNE in the PLAS Connector connects to. This PoP corresponds to the area of the PCNE in the network. At present, the value can only be Berlin or Frankfurt. Value range: 1-128 charactersAt present, the value can only be Berlin or Frankfurt. Value range: 1-128 characters |
Sample request
POST /v1.0/plasconnector/connectors HTTP/1.1
Content-Type:application/json
Accept:application/json;
X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB
{
"connector": {
"name": "plasconnector-1",
"bandwidth": 50,
"cloudInfo": {
"provider": "OTC",
"masterLocation": "Biere",
"masterDirectConnectId": "uuid1",
"slaveLocation": "Magdeburg",
"slaveDirectConnectId": "uuid2"
},
"networkInfo": {
"provider": "Telekom",
"networkDomain": "IPLS",
"masterLocation": "Biere",
"slaveLocation":"Magdeburg",
"lineId":"UUID",
"popLocation":"popLocationID"
}
}
}
Response¶
Parameter description
Parameter
Mandatory
Type
Description
location
Yes
String
Indicates the URL, through which you can query the operation progress.
The value is a string of 1 to 255 characters.
Sample response
HTTP/1.1 202 OK
Content-Type:application/json
Cache-Control:no-cache
{
"location":"/v1.0/plasconnector/connector/e7b778a7-5d94-4263-813f-4aec18473a5a/operations/95a44e38-5d61-44ca-a5c4-f241812fbd51"
}
Returned Value¶
Normal
Returned Value
Description
202 Accepted
The request has been accepted for processing, but the processing has not been completed.
Abnormal
Returned Value
Description
400 Bad Request
The server failed to process the request.
500 Internal Server Error
The server encountered an unexpected condition which prevented it from fulfilling the request.