CreatePrivateConnect

1. API Description

This API (CreatePrivateConnect) is used to create Private Connect

Notes

• Currently only postpaid fixed-bandwidth Private Connects can be created.

• For cloud access operations, see the Cloud Access Guide.

• This is an asynchronous API. Once the create request is successfully submitted, a Private Connect ID is returned, but the create operation is not completed immediately. During this period the instance status will be DEPLOYING. The creation result can be checked by calling the DescribePrivateConnects API -- if the status (privateConnectStatus) changes from DEPLOYING (creating) to AVAILABLE, the creation succeeded; if no record is found, the creation failed. Do not perform any operation on the Private Connect while it is being created.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
privateConnectName	Yes	String	Private Connect name, up to 255 characters. Defaults to private-connect-{current timestamp}.
bandwidthMbps	Yes	Integer	Maximum bandwidth limit for the Private Connect, in Mbps. Value range: [10, +) Default value: 10
endpointA	Yes	CreateEndpointParam	Endpoint A of the Private Connect.
endpointZ	Yes	CreateEndpointParam	Endpoint Z of the Private Connect.
resourceGroupId	No	String	Resource group ID. If not specified, the resource is placed in the default resource group.
tags	No	TagAssociation	Tags associated when creating the Private Connect. Note: associated tag keys must not be duplicated.
marketingOptions	No	MarketingInfo	Marketing activity information.

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.
orderNumber	String	Order number.
privateConnectId	String	Private Connect ID.

4. Code Example

Example

1. Create a Private Connect where Endpoint A is a data center port and Endpoint Z is a port, with a bandwidth of 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",
     "orderNumber": "your-order-number",
     "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
400	INVALID_GOOGLE_PAIRING_KEY	Invalid Google pairing key.
404	INVALID_PORT_NOT_FOUND	The port does not exist.
400	INVALID_PORT_STATUS	Invalid port status.
400	INVALID_ENDPOINT_PARAMETER	Unable to determine the endpoint type from the given parameters.