IoT Platform:Manage the endpoint of an instance

Usage notes

• If you use AMQP-based server-side subscriptions or call IoT Platform API operations to connect devices to an IoT Platform instance over the Internet by using Message Queuing Telemetry Transport (MQTT), Constrained Application Protocol (CoAP), or HTTP, you must specify a public endpoint when you configure the devices.

• If you use IoT Device ID to verify and connect devices to an IoT Platform instance over the Internet, you must specify the public endpoint as the value of the ID² parameter.

  Important

  The format of the ID² parameter values for public instances and Enterprise Edition instances is the same. For more information about the format, see View the endpoint of a public instance of the previous version.

• If you use AMQP-based server-side subscriptions or call IoT Platform API operations to connect devices to an IoT Platform instance over a virtual private cloud (VPC) by using MQTT, you must specify a VPC endpoint when you configure the devices.

• If you want to connect devices to an Enterprise Edition instance by using MQTT, you can bind a fixed IP address to the instance endpoint.

• If you use an Exclusive Enterprise Edition instance, you must create a separate MQTT endpoint. Then, you can specify a custom port number and certificate for the endpoint.

View the endpoint of a public instance of the previous version

Configure the parameters based on your business requirements. The following table describes the parameters.

View the endpoint of a public instance of the new version or an Enterprise Edition instance

1. Log on to the IoT Platform console. In the top navigation bar, select the region where the instance that you want to manage resides.

2. On the Overview tab, click the name or ID of the instance that you want to manage.

3. In the upper-right corner of the Instance Details page, click View Development Configurations.

   

4. In the Development Configurations panel, click the MQTT, CoAP, or HTTP tab to view the endpoint that is used by your device based on the protocol.

   Important

   • If you use an Exclusive instance, you must create an MQTT endpoint. For more information, see Create a separate MQTT endpoint for an Exclusive instance.

   • If IoT Device ID is enabled for Enterprise Edition instances, the ID² parameter is not available on the Manage ID² tab of the Development Configurations panel. For more information about the format of the ID² parameter, see the "View the endpoint of a public instance of the previous version" section in this topic.

   • If you connect devices to IoT Platform over HTTPS, the unique-certificate-per-device verification method and the pre-registration unique-certificate-per-product verification method are supported. However, the endpoints of the verification methods are different.

     • If you use the unique-certificate-per-device verification method, the endpoint is displayed on the HTTP tab.

     • If you use the pre-registration unique-certificate-per-product verification method, the IoT Platform instances to which you want to connect devices must reside in the China (Shanghai) region and use the iot-auth.cn-shanghai.aliyuncs.com endpoint.

   On each tab, perform the following operations:

   • Click Copy to copy the instance endpoint.

   • Move the pointer over the icon to the right of the endpoint to view the port number.

   Note

   For information about the port, see the "View the endpoint of a public instance of the previous version" section of this topic.

   

Bind a fixed IP address to an endpoint

Fixed IP addresses prevent your Domain Name System (DNS) records from being updated when IoT Platform expands the list of IP addresses. If you use IoT cards and your carrier does not support endpoints, you can add your fixed IP address to the list of directional IP addresses of the carrier.

To bind fixed IP addresses to the endpoint to which you want to connect devices over the Internet by using MQTT, perform the following steps:

• If you use a non-Exclusive Enterprise Edition instance, you can bind two fixed IP addresses to the endpoint.

  1. In the upper-right corner of the Instance Details page of the non-Exclusive Enterprise Edition instance, click View Developer Configurations.

  2. On the MQTT tab of the Development Configurations panel, click Configure to the right of Fixed IP.

  3. In the dialog box that appears, click OK to obtain two fixed IP addresses.

  If an MQTT device no longer requires fixed IP addresses, click Unbind.

• After you create a public MQTT endpoint for an Exclusive instance, the system automatically associates a fixed IP address with the instance. You do not need to perform additional operations. You cannot disassociate the fixed IP address from the instance.

Create a separate MQTT endpoint for an Exclusive instance

To create an MQTT endpoint for an Exclusive instance, perform the following steps:

1. In the upper-right corner of the Instance Details page of the Exclusive instance, click View Development Configurations.

2. On the MQTT tab of the Development Configurations panel, click Create.

3. In the Create Endpoint dialog box, configure the parameters. The following table describes the parameters.

   Parameter	Description
   Custom Port Number	The port number of the MQTT endpoint. Default value: 1883.
   Enable VPC	Yes: Enable VPCs. If you select Yes, you must specify a VPC, a zone, a vSwitch, and a security group. The system automatically creates a public MQTT endpoint and a VPC MQTT endpoint. Important If you want to enable VPCs for MQTT endpoints, you must activate PrivateLink for VPCs. If PrivateLink is not activated for your Alibaba Cloud account, you must go to the VPC console to activate PrivateLink. No (default): Disable VPCs. The system automatically creates a public MQTT endpoint. Important If you select No, you cannot enable VPCs.
   Authorization	If you want to enable VPCs, you must complete authorization. Click Authorize. The system automatically creates a role and a policy that grant devices the permissions on VPCs over which you want to connect the devices to IoT Platform. For more information, see Service-linked roles.
   VPC	After you enable VPCs and complete authorization, you must configure these parameters. Select an existing VPC and vSwitch in the current Alibaba Cloud account. You can click CreateVPC and CreateVSwitch to create a VPC and a vSwitch. For more information, see Create a VPC and Create a vSwitch.
   vSwitch Zone
   VSwitch
   Security Group	After you enable VPCs and complete authorization, you must configure this parameter. Select an existing security group in the current Alibaba Cloud account. You can click Create Security Group to create a security group. For more information, see Create a security group.

4. In the message that appears, click OK.

   After you create the endpoint, the endpoint is displayed in the Connect to MQTT Devices section.

Create a custom certificate for the MQTT endpoint of the Exclusive instance

To create a custom certificate and a domain name for the MQTT endpoint, perform the following steps:

1. In the upper-right corner of the Instance Details page of the Exclusive instance, click View Development Configurations.

2. In the Development Configurations panel, click MQTT. On the MQTT tab, click Configure in the Custom Certificate section.

3. In the Custom Certificate dialog box, set the Customize Configurations parameter to Enable.

   Note

   If the Customize Configurations parameter is already set to Enable, skip this step.

4. Specify the PEM-formatted content and key of a certificate that is obtained from a certificate authority (CA) and click OK.

   Warning

   If you want to update the certificate information after you specify the content and key of the certificate, certificate verification may fail. In this case, devices may fail to connect to IoT Platform or your business may be interrupted. Proceed with caution.

   The Development Configurations panel displays a custom domain name that is parsed from the custom certificate. You can use a custom endpoint to connect devices to IoT Platform over MQTT.

   Important

   You must configure a CNAME record at the domain name provider to resolve the custom domain name to the default MQTT endpoint of the instance.