This API is used to query details about a PLAS connector based on the connector ID.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
connector |
Yes |
PlasConnectorDetailModel object |
Indicates information about the PLAS connector. |
The PlasConnectorDetailModel object has the following attributes.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Indicates the PLAS connector ID. The value is a string of 1 to 36 characters. |
tenantId |
Yes |
String |
Indicates the tenant ID. The value is a string of 1 to 36 characters. |
name |
Yes |
String |
Indicates the name of the PLAS Connector. The name can consist of letters, digits, underscores (_), and hyphens (-). The value is a string of 1 to 128 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. |
status |
No |
String |
Indicates the PLAS connector status. Value range:
|
createTime |
No |
String |
Indicates the creation time. The time must be a UNIX timestamp accurate to milliseconds. The value is a string of 1 to 36 characters. |
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 connects to. 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 connects to. 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 connects to. 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. |
HTTP/1.1 200 OK
Content-Type:application/json
Cache-Control:no-cache
{
"connector": {
"id": "uuid",
"tenantId": "uuid",
"name": "plasconnector-1",
"description":"connector description",
"bandwidth": 50,
"cloudInfo": {
"provider": "OTC",
"masterLocation": "Biere",
"masterDirectConnectId": "uuid1",
"slaveLocation": "Magdeburg",
"slaveDirectConnectId": "uuid2"
},
"networkInfo": {
"provider": "Telekom",
"networkDomain": "IPLS",
"masterLocation": "Biere",
"slaveLocation":"Magdeburg",
"lineId":"UUID"
},
"status": "Available",
"createTime": "1223445454"
}
}
Returned Value |
Description |
---|---|
200 OK |
Details about the PLAS connector are returned. |
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. |