Acquire Endpoint

When confirming the Endpoint configured when you use the SDK, you can first read the section on VPC Service Domain Name in the Developer Guide to understand the Endpoint concept. Baidu AI Cloud currently opens the multi-region (Region) support. Please refer to the part of network product VPC in Region Selection Introduction. The peer connection services are a part of VPC services, and use the VPC service domain name.

Get the Key

To use Baidu Cloud products, you need to have a Baidu Cloud account and a valid AK (Access Key ID) and SK (Secret Access Key) for signature verification. You can obtain and understand your AK/SK information through the following steps:

1.[Register Baidu Cloud Account](https://login.bce.baidu.com/reg.html? tpl=bceplat&from=portal)

2.[Create AK/SK](https://console.bce.baidu.com/iam/? _=1513940574695#/iam/accesslist)

Peerconn_client

The peerconn_client encapsulates the API of peer connection services, and simplifies the interaction between developers and peer connection services. The users can call the methods in peerconn_client to configure the peer connection. The method return parameter in peerconn_client is consistent with API Method.

Create peerconn_client

When creating peerconn_client, you need to first use Endpoint, AK and SK to configure the BceClientConfiguration type config instance, and then use the config instance to configure the peerconn_client. The specific configuration method is as follows:

HOST = b''
 AK = b''
 SK = b''
 config = BceClientConfiguration(
     credentials=BceCredentials(AK, SK), endpoint=HOST)
 self.client = peerconn_client.PeerConnClient(config)

Create a Peer Connection

When the peer connection is created, attention should be paid to:

• For the peer connection of the same account, the system will trigger the opposite terminal for automatic acceptance.
• For the cross-account peer connection, the peer connection is available only after being accepted by the acceptor.
• For the peer connections with the same local region and opposite terminal region, the billing parameter only supports the postpaid (the billing parameter should be transmitted, but the bill is 0).
• Only one peer connection exists between any two VPC.
• The VPCs of the initiator and the acceptor cannot be the same.
• If the local vpc and opposite terminal vpc are both relay vpc, the peer connection cannot be established.

The create_peerconn function can be used to create the peer connection in the specified VPC, and is defined as below:

@required(bandwidth_in_mbps=int,
           local_vpc_id=(bytes, str),
           peer_vpc_id=(bytes, str),
           peer_region=(bytes, str))
def create_peerconn(self, bandwidth_in_mbps, local_vpc_id,
                    peer_vpc_id, peer_region, description=None,
                    local_if_name=None, peer_account_id=None,
                    peer_if_name=None, client_token=None,
                    billing=None, config=None)

The parameters are described as follows:

For the customized Billing type definition, refer to peerconn_model.py. The region parameter is as follows:

Query the Peer Connection List

The list_peerconns function can be used to query the peer connection list, and is defined as below:

@required(vpc_id=(bytes, str))
def list_peerconns(self, vpc_id, marker=None,
                   max_keys=None, config=None)

The parameters are described as follows:

Query the Peer Connection Details

The get_nat function can be used to query the NAT details, and is defined as below:

@required(peer_conn_id=(bytes, str))
def get_peerconn(self, peer_conn_id, config=None)

The parameters are described as follows:

Update the Local Interface Name and Comments of peer Connection

The update_peerconn function can be used to update the peer connection, and is defined as below:

@required(peer_conn_id=(bytes, str), local_if_id=(bytes, str))
def update_peerconn(self, peer_conn_id, local_if_id, description=None,
                    local_if_name=None, client_token=None, config=None)

The parameters are described as follows:

Process the peer Connection Application

• When the connection request timeout initiated by the initiator is 7 days, the status of the peer connection of the initiator after time-out is "Consultation Failed".
• After the acceptor denies, the status of the peer connection of the initiator is "Consultation Failed".

The handle_peerconn function can be used to update the peer connection, and is defined as below:

@required(peer_conn_id=(bytes, str), action=(bytes, str))
def handle_peerconn(self, peer_conn_id, action, client_token=None,
                    config=None)

The parameters are described as follows:

Release the Peer Connection

The delete_peerconn function can be used to release the peer connection, and is defined as below:

@required(peer_conn_id=(bytes, str))
def delete_peerconn(self, peer_conn_id, client_token=None,
                    config=None)

The parameters are described as follows:

Upgrade and Degrade of peer Connection Bandwidth

The resize_peerconn function can be used to release the peer connection, and is defined as below:

@required(peer_conn_id=(bytes, str), new_bandwidth_in_mbps=int)
def resize_peerconn(self, peer_conn_id, new_bandwidth_in_mbps,
                    client_token=None, config=None)

The parameters are described as follows:

Peer Connection Renewal

• The postpaid peer connection cannot be renewed.
• The cross-account renewal can only be operated by the initiator.

The purchase_reserved_peerconn function can be used to release the peer connection, and is defined as below:

@required(peer_conn_id=(bytes, str))
def purchase_reserved_peerconn(self, peer_conn_id, client_token=None,
                               billing=None, config=None)

The parameters are described as follows:

Open the Synchronous DNS of peer Connection

• The DNS can be enabled only when the status of peer connection is "available".
• The synchronization of DNS cannot be enabled when the DNS status of peer connection is "Synchronizing" or "Synchronization Closed".

The open_peerconn_dns_syn function can be used to release the peer connection, and is defined as below:

@required(peer_conn_id=(bytes, str), role=(bytes, str))
def open_peerconn_dns_sync(self, peer_conn_id, role,
                           client_token=None, config=None)

The parameters are described as follows:

Close the Synchronous DNS of peer Connection

• The DNS can be closed only when the status of peer connection is "available".
• The synchronization of DNS cannot be closed when the DNS status of peer connection is "Synchronizing" or "Synchronization Closed".

The close_peerconn_dns_syn function can be used to release the peer connection, and is defined as below:

@required(peer_conn_id=(bytes, str), role=(bytes, str))
def close_peerconn_dns_sync(self, peer_conn_id, role,
                            client_token=None, config=None)

The parameters are described as follows: