About TSDB Policy Service API V2.1¶
This version is available for the EnOS 20200831 and later releases. For the previous version, see V2.0.
Refer to the table below for the list of APIs, and whether they can be used by EnOS Cloud and EnOS Edge.
This version is available for the EnOS 20200831 and later releases. For the previous version, see V2.0.
Refer to the table below for the list of APIs, and whether they can be used by EnOS™ Cloud and EnOS™ Edge.
API List¶
| API Name | Description | EnOS Cloud | EnOS Edge |
|---|---|---|---|
| Get Storage Policy | Get detailed information of specified storage policy with storage policy ID | √ | √ |
| Get Unformatted Policy | Get information of organization’s unformatted storage policy, including storage policy ID, update time and retention | √ | × |
| Save Storage Policy | With storage policy ID, update and save the configuration of specified storage policy | √ | × |
| Update Unformatted Policy | Update the data storage time of organization’s unformatted storage policy | √ | × |
Recommend Poseidon version:
<dependency>
<groupId>com.envisioniot</groupId>
<artifactId>apim-poseidon</artifactId>
<version>0.1.14</version>
</dependency>
API Editions¶
The following table lists the API services included in TSDB Policy Service Enterprise and Lightweight editions.
| Operation Name | Enterprise | Lightweight |
|---|---|---|
| Get Storage Policy | √ | √ |
| Get Unformatted Policy | √ | × |
| Save Storage Policy | √ | × |
| Update Unformatted Policy | √ | × |
Common Error Codes¶
| Code | Message | Description |
|---|---|---|
| 0 | OK | API request is successful. |
| 80500 | INTERNAL SERVER ERROR | Internal server error. For details, check the returned error message. |