DestroyPort

DestroyPort

1. API Description

This API is used to release a port.

Prerequisites

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

Note

• This operation is irreversible. Once the operation is successful, the port will be completely released. Please operate with caution.

• Only operations on ports in recycle bin are supported.

• This API is an async API. A request ID is returned after the release request is sent. However, it does not mean the releasing has been completed. The status of the port will be DESTROYING during the releasing. You can use DescribePorts to query the status of the port. If the status of the port changes DESTROYING to DESTROYED, it means that the port has been released successfully. Any operations on the port are not allowed while releasing.

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

Release a port.

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