Doc CenterSign in to zenConsole

DeletePrivateConnect

1. API Description

This API is used to delete a Layer 2 private connect.

Note

  • If you delete your private connect, the Layer 2 network connection will be interrupted and corresponding business will stop. Please operate with caution.

  • After deletion, your resources will be suspended for a specified time with the state of RECYCLED. See Cloud Networking Billing for details. During this time, you can call RenewPrivateConnect to restore your resources.

  • This API is an async API. A request ID is returned after the deletion request is sent. However, it does not mean the deletion has been completed. The status of the private connect will be DELETING during the deletion. When the state of private connect changes to RECYCLED, it means that the private connect has been deleted successfully.

  • Any change operations on the deleted private connects are not allowed.

  • After deletion, you can RenewPrivateConnect to restore your resources or call DestroyPrivateConnect to release the deleted resources according to your actual needs.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

privateConnectId

Yes

String

Private connect 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

Delete a Layer 2 private connect.

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

Request：
{
    "privateConnectId": "your-private-connect-id"
}

Response：
{   
  "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"，
  }
}

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

No error codes related to the API business logic. For other error codes, see Common Error Codes.​

Last updated