CreatePrivateConnect

1. API Description

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

Prerequisites

• Query available ports You can call DescribePrivateConnectAvailablePorts to query ports that can be added in to the Layer 2 private connect.

• Query available locations for public clouds

  • You can call DescribeGoogleRegions to query locations supporting for Google Cloud access point.

  • You can call DescribeAWSRegions to query locations supporting for AWS access point.

  • You can call DescribeTencentRegions to query locations supporting for Tencent Cloud access point.

• Cloud Connect access bandwidth will be automatically adjusted to the nearest cap higher than the backbone bandwidth. If you need to configure Cloud Connect access bandwidth separately, you can call DescribeCloudAvailableBandwidthTiers to query available cloud connect access bandwidth specifications.

Note

• Only operations on pay-as-you-go private connects billed by flat rate are supported.

• Please view Connections Validation on Public Cloud for more details.

• This API is an async API. A private connect ID is returned after the creation request is sent. However, it does not mean the creation has been completed. The status of the private connect will be DEPLOYING during the creation. You can use DescribePrivateConnects to query the status of the private connect. If the status changes from DEPLOYING to AVAILABLE, it means that the private connect has been created successfully; if no result has been queried, it means the private connect has been created failed. Any operations on the private connect are not allowed while creating.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
privateConnectName	No	String	Private connect name. Up to 255 characters in length are allowed. The default is private-connect-{current time}.
endpointA	Yes	CreateEndpointParam	One access point (A) of the private connect.
endpointZ	No	CreateEndpointParam	The other access point (Z) of the private connect.
bandwidthMbps	No	Integer	Maximum bandwidth cap of the private connect, ranging from 1 to 500. Default value: 1 Unit: Mbps
resourceGroupId	No	String	Resource group ID. If the value is null, then return all the private connects in the authorized resource groups.
marketingOptions	No	MarketingOptions	Information on marketing campaigns.
tags	No	TagAssociation	Bound tags when creating the private connect. Tag keys must be unique.

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.
privateConnectId	String	Private connect ID.

4. Code Example

Example

Create a Layer 2 private connect with ports as both access point A and access point Z. The bandwidth cap is 10 Mbps.

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

Request：
{
   "endpointA": {
      "vlanId": 1001,
      "portId": "your port id"
   },
   "privateConnectName": "fra-sel-prviate-line",
   "endpointZ": {
      "vlanId": 2001,
      "portId": "your portId id"
   },
   "bandwidthMbps": 10
}

Response：
{   
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"，
     "privateConnectId": "your private connect id"
  }
}

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
404	INVALID_PORT_NOT_FOUND	Port does not exist.
400	INVALID_PORT_STATUS	The state of port should be Available.
400	INVALID_ENDPOINT_PARAMETER	Invalid access point type.
400	INVALID_CONNECT_ENDPOINT_CONFLICT	Duplicated access point A and Z.