ModifyPortAttribute

ModifyPortAttribute

1. API Description

This API is used to modify attributes of a port.

Prerequisites

Before modifying attributes of a port, you can call DescribePorts to query port list.

Note

You can only modify businessEntityName when LOA file has not been uploaded.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
portId	Yes	String	Port ID.
portName	No	String	Port name. Up to 255 characters in length are allowed. You're recommended to use data center code combined with port speed.
portRemarks	No	String	Note of port. Up to 255 characters in length are allowed.
businessEntityName	No	String	Your business entity name. The entity name to be used on the Letter of Authorization (LOA). This should be the name that is registered with the colocation facility.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Example

Modify attributes of a port.

POST /api/v2/sdn HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyPortAttribute
<Common Request Params>

Request:
{
  "portId": "your-port-id"
}

Response:
{
  "requestId": "T3811A0E7-C250-40A2-96AD-08AD759E1BC2",
  "response": {
    "requestId": "T3811A0E7-C250-40A2-96AD-08AD759E1BC2"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
7105	SELF_SERVICE_PORT_NOT_FOUND	Port not found.
7109	SELF_SERVICE_PORT_NOT_SUPPORT_BUSINESS_LOA_DONE	Operations are not supported because LOA has been uploaded already.