About EnOS Data Subscription APIs¶
EnOS Data Subscription is an active push service launched by EnOS Cloud to improve the efficiency of users’ acquisition and utilization of asset data. Through this service, the application does not need to continuously poll the data extraction API to obtain asset time series data, alert data, asset event data, etc., which significantly improves the API call efficiency and reduces the usage cost.
EnOS Data Subscription Service provides a series of open APIs open by EnOS to help you get subscription job lists, job details, and update subscription jobs. For a complete list of interfaces and functional descriptions of EnOS Data Subscription Service APIs, see API List.
API List¶
You can see what operations can be used via these APIs, the URL corresponding to each operation, and whether it is applicable to EnOS Cloud and EnOS Edge in the following table.
Operation Name |
Description |
URL |
EnOS Cloud |
EnOS Edge |
|---|---|---|---|---|
Get a list of subscription jobs. |
/subscription-service/v1/subscriptions |
√ |
× |
|
Get subscription job details by job ID. |
/subscription-service/v1/subscription/{subId} |
√ |
× |
|
Update a subscription job. |
/subscription-service/v1/subscription |
√ |
× |
Common Error Code¶
You can learn about the common error codes of Data Subscription APIs through the following table.
Code |
Error Message |
Description |
|---|---|---|
400001 |
Parameter illegal |
Invalid parameters. |
400002 |
Subscription ID, SA, organization or type fields are not allowed to be updated |
Does not support updating subscription ID, application access key, OU ID, or subscription type. |
400003 |
Number of point in the subscription exceeds the limit |
The number of measurement points in the subscription job exceeds the limit. |
403001 |
Permission denied |
No permission yet. |
404001 |
Subscription does not exist |
Subscription job does not exist. |
500001 |
System error |
System exception. |