Modifying a PLAS Connector¶
Function¶
This API is used to modify a PLAS connector based on the connector ID. Based on the URL returned, you can query the modification progress.
URI¶
URI format
PUT /v1.0/plasconnector/connectors/{connector_id}
Parameter description
Parameter
Mandatory
Type
Description
connector_id
Yes
String
Indicates the PLAS connector ID.
The value is a string of 1 to 36 characters.
Request¶
Parameter description
Parameter
Mandatory
Type
Description
PlasConnector
Yes
PlasConnectorUpdateReq object
Indicates information about the PLAS connector.
The PlasConnectorUpdateReq object has the following attributes.
Parameter | Mandatory | Type | Description |
|---|---|---|---|
connector | Yes | PlasConnectorUpdateModel object | Indicates the request for modifying a PLAS connector. |
The PlasConnectorUpdateModel object has the following attributes.
Parameter | Mandatory | Type | Description |
|---|---|---|---|
name | No | String | Indicates the name of the PLAS connector name. 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 connector description. The value is a string of 0 to 255 characters. |
bandwidth | No | int32 | Indicates the bandwidth in Mbit/s. Value range:
|
lineId | No | String | Indicates the line ID, which is assigned by the CCR. The value is a string of 1 to 36 characters. |
Sample request
PUT /v1.0/plasconnector/connectors/e7b778a7-5d94-4263-813f-4aec18473a5a HTTP/1.1
Content-Type:application/json
Accept:application/json;
X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB
{"connector" : {"name" :"modifyLiu",
"description" : "modifyLiu",
"bandwidth" : 11,
"networkInfo": {"lineId":"UUID"
}
}
}
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 200 OK
Content-Type:application/json
Cache-Control:no-cache
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
200 OK
The PLAS connector is successfully modified.
202 OK
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.