Integration overview
The IoT Edge OpenAPI is part of the Link Visual product in the Alibaba Cloud OpenAPI portal. You can use methods such as online OpenAPI debugging and Alibaba Cloud software development kits (SDKs) to efficiently develop and deploy your applications.
Version guide
The API list for online debugging uses version 2018-01-20. This string is an API version number, not a date. The list displays the latest public API data and has been updated since this version. To learn how to view the API version, see View API versions.
Version number |
Description |
Recommended |
Online debugging
Alibaba Cloud IoT Edge supports API debugging on the Alibaba Cloud OpenAPI Portal. Before you start debugging, you must understand the API version, endpoints, and API parameters.
Debugging entry point
Debugging pages: IoT Edge API debugging.
Endpoint details
Endpoints are the entry points for accessing Alibaba Cloud services. They are divided into public endpoints and VPC endpoints.
Public endpoints are accessible globally.
VPC endpoints are accessible only from within a Virtual Private Cloud (VPC) in the corresponding Alibaba Cloud region. VPC endpoints provide the following benefits:
High security: VPC endpoints can be accessed only from within a VPC. This provides greater security and privacy.
Faster response times: Because VPC endpoints operate within the VPC internal network, their response times are typically faster than public endpoints. They also avoid issues such as public network latency and bandwidth limitations.
Lower costs: VPC endpoints use internal network communication. This reduces reliance on external traffic and can effectively lower costs associated with public bandwidth usage.
When you select an endpoint, choose one that is closest to your users or business. This can reduce network latency and improve data transfer speeds and application response times. For example, if your main user base is in Hangzhou, select the endpoint in the Hangzhou region.
You can view the endpoints for Alibaba Cloud IoT Edge in Regions.
User identity
When you log on to the OpenAPI Portal with your Alibaba Cloud account, OpenAPI uses this account for online debugging by default. An Alibaba Cloud account has access to all APIs, which poses a high security risk. We recommend that you create and use a Resource Access Management (RAM) user for API access or daily operations and maintenance (O&M). You must grant the required permissions to the RAM user before you make API calls. The RAM user must have the required permissions to access IoT Platform. For more information, see RAM authorization for IoT Platform
User identity |
Support status |
Support |
|
RAM user (Recommended) |
Support |
RAM role (Recommended) |
Support |
More information
Integration methods
The SDK is the easiest and best-supported method for making OpenAPI calls. We recommend that you use the SDK for your integration.
Integration method |
Support |
Support |
|
No |
|
No |
|
No |
|
Support |
Alibaba Cloud SDK
Alibaba Cloud provides SDKs for multiple programming languages, such as Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. Developers can integrate an SDK and call the OpenAPI directly through the methods exposed by the SDK. The SDK encapsulates the signing logic, timeout mechanism, and retry mechanism. It also provides Request and Response objects for the interface, which simplifies development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.
You can use the Link Visual SDK to call OpenAPI. For more information about the supported languages and dependency installation methods, see Link Visual SDK.
Alibaba Cloud CLI
Alibaba Cloud Command Line Interface (CLI) lets you use the
aliyuncommand in a terminal to interact with Alibaba Cloud services and manage your cloud resources. For more information about Alibaba Cloud CLI, see What is Alibaba Cloud CLI?.Alibaba Cloud CLI is not supported for calling IoT Edge services.
Terraform
Terraform is an open source tool that you can use to safely and efficiently preview, configure, and manage cloud infrastructure and resources. Its operating mechanism is similar to that of Alibaba Cloud ROS. Terraform converts templates into internal data to complete OpenAPI calls. For more information, see What is Terraform?.
Terraform is not supported for orchestrating IoT Edge services.
Resource Orchestration Service (ROS)
Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies cloud computing resource management. It allows developers and administrators to write templates that define required Alibaba Cloud resources, such as ECS instances and RDS database instances, and their dependencies. The ROS orchestration engine automatically creates and configures all resources based on the template. This automates deployment and O&M. For more information, see What is Resource Orchestration Service?.
ROS is not supported for calling IoT Edge services.
Custom API call encapsulation
For native HTTP calls, you must implement the signature algorithm, build a custom request, and initiate the HTTP call. For more information about the signing mechanism, see IoT Edge API Reference and V3 request body & signing mechanism.
Notes
The queries per second (QPS) limit for a single Alibaba Cloud account varies by API. For more information, see the QPS limit section in the documentation for each API.
NoteAll RAM users under a single Alibaba Cloud account share the QPS quota of that account.
If an API call returns an error, use the returned error code to check the request parameters and their values. For more information, see Error codes.
You can also record the RequestID or the SDK error message from the API call and use Alibaba Cloud OpenAPI Troubleshoot to diagnose the issue.