هذه الصفحة غير متوفرة حاليًا بلغتك المحلية. نحن نعمل جاهدين على إضافة المزيد من اللغات. شاكرين تفهمك ودعمك المستمر لنا.
- What's New
- Product Bulletin
- Service Overview
- Getting Started
-
User Guide
- Edge Computing with IEF
- Service Instances
-
User Guide (Professional)
- Node Management
-
End Device Management
- End Devices and Device Twins
- Device Templates
- End Devices
- Binding an End Device to an Edge Node
- Device Twin Working Principles
- Migrating Device Data to the Cloud
- Performing Security Authentication Using Certificate
-
MQTT Topics
- Device Twin Update
- Device Twin Delta
- Device Member Update
- Device Property Update
- Device Member Acquisition
- Device Member Acquisition Result
- Device Twin Acquisition
- Device Twin Acquisition Result
- Device Twin Modification
- Device Twin Modification Result
- Encryption Data Request
- Encryption Data Acquisition
- Alarm Reporting
- Alarm Clearance
- Custom Topics
- Containerized Application Management
- Edge-Cloud Messages
- Batch Management
- Auditing
- Permissions Management
-
User Guide (Platinum)
- Node Management
-
End Device Management
- End Devices and Device Twins
- Device Templates
- End Devices
- Binding an End Device to an Edge Node
- Device Twin Working Principles
- Migrating Device Data to the Cloud
- Performing Security Authentication Using Certificate
-
MQTT Topics
- Device Twin Update
- Device Twin Delta
- Device Member Update
- Device Property Update
- Device Member Acquisition
- Device Member Acquisition Result
- Device Twin Acquisition
- Device Twin Acquisition Result
- Device Twin Modification
- Device Twin Modification Result
- Encryption Data Request
- Encryption Data Acquisition
- Alarm Reporting
- Alarm Clearance
- Custom Topics
- Containerized Application Management
- Application Mesh
- Edge-Cloud Messages
- Batch Management
- Auditing
- Permissions Management
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
-
Edge Node Management
- Registering an Edge Node
- Updating an Edge Node
- Querying Details About an Edge Node
- Querying a List of Edge Nodes
- Deleting an Edge Node
- Starting or Stopping an Edge Node
- Updating End Devices for an Edge Node
- Querying Node Certificates
- Creating a Node Certificate
- Deleting a Node Certificate
- Performing an Edge Node Upgrade Check
- Upgrading Edge Nodes
- End Device Management
- End Device Template Management
-
Application Template Management
- Creating an Application Template
- Updating an Application Template
- Querying Details About an Application Template
- Querying a List of Application Templates
- Deleting an Application Template
- Creating an Application Template Version
- Updating an Application Template Version
- Querying Details About an Application Template Version
- Querying a List of Application Template Versions
- Deleting an Application Version
- Deployment Management
- Tag Management
- ConfigMap Management
- Secret Management
- Endpoint Management
- Rule Management
- System Subscription Event Management
- Batch Node Management
- Batch Job Management
- Quota Management
- Service Management
-
Edge Node Management
- Data Structure
- Permissions Policies and Supported Actions
- Appendix
- Change History
- SDK Reference
-
FAQs
-
Edge Node FAQs
- What Do I Do If an Edge Node Is Faulty?
- What Are the Fault Scenarios of Edge Nodes?
- What Do I Do If Edge Node Management Fails?
- How Do I Obtain the Latest Device Properties After Device Properties Are Updated?
- What Operations Can I Perform After a Device Is Associated with a Node?
- Does an Edge Node Support Multiple GPUs?
- Can I Change the GPU on a Running Edge Node?
- How Is Edge Environment Security Protected?
- Why Cannot I View Monitoring Data on an Edge Node?
- How Can I Restore a Deleted Edge Node?
- What Is the Impact of IP Address Changing on an Edge Node?
- What Do I Do If the NTP Configuration Cannot Be Modified?
- How Do I Synchronize Time with the NTP Server?
- How Do I Obtain the IP Addresses of IEF Cloud Services?
- What Do I Do If the Edge Node Space Is Insufficient?
- How Do I Set Docker Cgroup Driver After Installing Docker on an Edge Node?
-
Edge Application FAQs
- What Do I Do If an Application Fails to Be Delivered to an Edge Node?
- What Do I Do If a Containerized Application Fails to Be Started on an Edge Node?
- What Do I Do If a Containerized Application Fails to Be Upgraded?
- What Do I Do If a Container Image Fails to Be Pulled?
- Why Cannot I View Application Logs and System Logs?
- How Do Applications Schedule GPU Resources?
- How Do I Control the Disk Space Occupied by a Container Engine?
- What Do I Do If a Containerized Application Cannot Access External IP Addresses
- What Do I Do If the Ascend AI Accelerator Card (NPU) Is Abnormal?
-
Edge-Cloud Message FAQs
- What Is Route Management?
- What Is a Message Endpoint in Route Management?
- What Is a Route?
- Why Does a Route Fail to Be Created?
- What Can I Do If a Message Fails to Be Forwarded over a Route?
- What Is the Impact of Disabling a Route?
- What Can I Do If SystemEventBus (MQTT Broker) of an Edge Node Fails to Be Connected?
- Network Management FAQs
- Basic Concept FAQs
-
Others
- Region and AZ
- What Are the Specifications of Edge Nodes Supported by IEF?
- What Are the Differences Between Device Properties and Device Twins?
- What Programming Language Is Required for IEF Development?
- Do I Need to Prepare Edge Nodes by Myself?
- Can I Still Use the Previously Delivered Applications After My Account Is in Arrears?
- What Are the Differences Between IEF and IoT Edge?
- What Do I Do If an Agency Fails to Be Automatically Created?
- How Can I Deal With Insufficient Permissions?
- How Will the Multi-AZ Reconstruction of SWR Application Container Image Data Affect IEF?
-
Edge Node FAQs
-
Edgectl User Guide
- Overview
- Installing edgectl
- Example: Using edgectl to Run Commands
-
edgectl Commands
- Querying the edgectl Version
- Managing the Product Lifecycle
-
Checking an Item
- Checking the Hardware Architecture
- Checking the CPU
- Checking the Memory
- Checking Hard Disks
- Checking the Domain Name Resolution Function
- Checking Docker
- Checking Network Connectivity
- Checking the Installation Status of the IEF Software
- Checking the Running Status of the IEF Software
- Checking GPUs
- Checking NPUs
- Checking Processes
-
Error Codes
- Error Code Overview
- Common Errors
- Permission Errors
-
OS Errors
- ERROR3001 Failed to obtain the hardware architecture
- ERROR3002 Unsupported hardware architecture
- ERROR3101 Failed to obtain the CPU information of the node
- ERROR3102 Failed to obtain the real-time CPU status of the node
- ERROR3103 Insufficient node CPU
- ERROR3201 Failed to obtain the memory information of the node
- ERROR3202 Insufficient node memory
- ERROR3301 Failed to obtain the disk information of the node
- ERROR3302 Insufficient disk space on the node
- ERROR3401 Failed to resolve the domain name
- ERROR3501 Failed to check the network
- ERROR3601 Failed to obtain the process information of the node
- ERROR3602 Failed to obtain the total number of processes on the node
- ERROR3603 Number of remaining processes on the node is insufficient
-
IEF Software Errors
- ERROR5001 Incomplete IEF software installation
- ERROR5002 IEF software is not completely running
- ERROR5003 Failed to read the IEF software configuration file
- ERROR5004 Docker is not enabled for the IEF software
- ERROR5005 Failed to start the IEF software
- ERROR5006 Failed to stop the IEF software
- ERROR5101 No application data found
- ERROR5102 No status data of the application found
- ERROR5103 Container is not started
- ERROR5104 Container exits abnormally
- ERROR5105 Failed to pull the container image
- ERROR5106 Container exits
- Third-Party Dependency Errors
- Data Collection Errors
- Internal Errors
- Videos
- General Reference
Copied.
System Subscriptions
Scenario
IEF provides the system subscription function for you to subscribe to IEF resource change events. When a resource is created, updated, or deleted, IEF will send a message to the specified API Gateway endpoint so that you can obtain resource changes in a timely manner.
System subscription is the special implementation of edge-cloud messages. IEF sends event messages about specific resources to a specified topic and calls an API of API Gateway to notify you of resource changes.
Events That Can Be Subscribed To
You can subscribe to the following events from IEF.
System Event |
Topic |
Resource Type |
Operation |
---|---|---|---|
Instance creation |
$hw/events/instance/+/created |
Application instance |
Create |
Instance update |
$hw/events/instance/+/updated |
Application instance |
Update |
Instance deletion |
$hw/events/instance/+/deleted |
Application instance |
Delete |
Application deletion |
$hw/events/deployment/+/deleted |
Containerized application |
Delete |
Application creation |
$hw/events/deployment/+/created |
Containerized application |
Create |
Application update |
$hw/events/deployment/+/updated |
Containerized application |
Update |
Node being brought online |
$hw/events/edgeNode/+/online |
Edge node |
Bring online |
Node being brought offline |
$hw/events/edgeNode/+/offline |
Edge node |
Bring offline |
System Subscription Process
The system subscription process is as follows:
- Create an API on API Gateway for IEF to call.
- Create an API Gateway endpoint on IEF.
- Create a system subscription on IEF.
Creating an API
Create an API on API Gateway. For details, see Getting Started.
This API is called by IEF to send system event messages.
Creating an API Gateway Endpoint
- Log in to the IEF console.
- In the navigation pane, choose Edge-Cloud Messages > Endpoints.
- Click Create Endpoint in the upper right corner, and set the endpoint parameters.
Figure 1 Creating an endpoint
- Type: Select API Gateway.
- Name: Enter an endpoint name.
- Click OK. The endpoint is successfully created and the endpoint list page is displayed.
Creating a System Subscription
- Log in to the IEF console.
- In the navigation pane, choose Edge-Cloud Messages > System Subscriptions.
- Click Create System Subscription in the upper right corner, and set the system subscription parameters.
Figure 2 Creating a system subscription
- Name: Enter a system subscription name.
CAUTION:
System subscriptions and message routes are of the same resource type. Their names cannot conflict with each other.
- Topic: Select the resource and operation to be subscribed, for example, creating a containerized application. For details about the events that can be subscribed to, see Table 1.
- Destination Endpoint: Select the endpoint created in Creating an API Gateway Endpoint.
- Destination Endpoint Resource: Select the API created in Creating an API.
- Name: Enter a system subscription name.
- Click Create.
Message Forwarding After Subscription
After a system subscription is created, IEF will forward a message when a system event occurs. The statistics about message forwarding can be viewed on the System Subscriptions page of the IEF console.

Meanwhile, IEF will call the API registered on API Gateway. The request body is as follows: (The request body uses the standard CloudEvents format. For details, see CloudEvents.)
{ "data": { "event_type": "instance", "operation": "created", "timestamp": 134567677, "topic": "$hw/events/deployment/+/created", "name": "xxxx", "attributes": {"ID":"x"} }, "datacontenttype": "application/json", "source": "sysevents", "id": "xxxx", "time": "2020-11-5 xxx" }
- data: system event data.
- event_type: resource type. The value is a character string.
- operation: operation performed on the resource. The value is a character string.
- topic: topic to which a message is sent. The value is a character string.
- timestamp: time when an event occurs. The value is of the UInt64 type.
- name: resource name. The value is a character string.
- attributes: resource attributes. This parameter is not contained in the request for deleting a resource. The value is of the Object type.
- datacontenttype: format of the system event data content. The value is a character string.
- source: source of the system event. The value is a character string.
- id: system event ID, which is a character string.
- time: time when the system event occurs. The value is a character string.
Table 1 lists the resource types, operations, and topics supported by IEF.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot