TerminatePort

TerminatePort

1. API Description

This API is used to terminate a port.

Prerequisites

Before terminating a port, you can call DescribePorts to query port list.

Note

• Use this API to return a port that is no longer required. A pay-as-you-go port will stop billing after it is returns.

• You cannot return a subscription port using this API, which will be returned when subscription expires.

• When this API is called, the port will be moved to the recycle bin and be released in 24 hours if there are no other operations. You can also call DestroyPort to release the elastic IP.

• Operations on ports in recycle bin or in creating status are not supported.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
portId	Yes	String	Port ID.

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

Terminate a port.

POST /api/v2/sdn HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: TerminatePort
<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.