Get Storage Policy¶
根据存储策略ID,获取指定存储策略的详细信息,包括存储策略名称、存储数据类型、存储时长,以及存储策略中配置的模型测点和压缩配置信息。
请求格式¶
GET https://{apigw-address}/tsdb-policy/v2.1/policies/{policyId}
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
policyId |
Path |
必需 |
String |
存储策略ID,可通过 EnOS管理门户 > 时序数据管理 > 存储策略 页面获取指定存储类型的存储策略ID。 |
orgId |
Query |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
List<JSONObject> |
存储策略的详细信息。详见 存储策略结构体 |
存储策略结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
policyId |
String |
存储策略ID。 |
policyName |
String |
存储策略名称。 |
policyType |
String |
存储策略类型。 |
retention |
String |
数据存储时长。 |
models |
List<JSONObject> |
模型测点存储策略详细信息。详见 模型测点结构体 |
模型测点结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
modelId |
String |
模型ID。 |
points |
List<JSONObject> |
模型中已配置存储策略的测点列表,以及测点数据压缩配置。详见 测点数据压缩配置 |
测点数据压缩配置 ¶
名称 |
数据类型 |
描述 |
---|---|---|
pointId |
String |
测点ID。 |
sdt |
JSONObject |
旋转门压缩参数配置,包括 |
db |
JSONObject |
死区压缩参数配置,包括 |
示例¶
{
"policyId": "aa8bbcba-2919-4c78-854c-54984d85d2fa",
"policyName": "AI Normalized Data",
"policyType": "NORMALIZED",
"retention": "6M",
"models": [
{
"modelId": "model_1",
"points": [
{
"pointId": "test_point1",
"sdt": {
"compdev": 0.22,
"compmax": 2200,
"compmin": 22
},
"db": {
"excdev": 0.11,
"excmax": 100,
"excmin": 11
}
},
{
"pointId": "test_point2",
"sdt": null,
"db": null
},
{
"pointId": "test_point3",
"sdt": {
"compdev": 0.22,
"compmax": 2200,
"compmin": 22
},
"db": null
}
]
},
{
"modelId": "model_2",
"points": [
{
"pointId": "test_point3",
"sdt": {
"compdev": 0.22,
"compmax": 2200,
"compmin": 22
},
"db": {
"excdev": 0.11,
"excmax": 1100,
"excmin": 11
}
}
]
}
]
}
错误码¶
有关错误码的描述,参见 通用错误码。
示例¶
请求示例¶
url: https://{apigw-address}/tsdb-policy/v2.1/policies/aa8bbcba-2919-4c78-854c-54984d85d2fa?orgId=yourOrgId
method: GET
返回示例¶
{
"code": 0,
"msg": "OK",
"submsg": null,
"data": {
"policyId": "aa8bbcba-2919-4c78-854c-54984d85d2fa",
"policyName": "AI Normalized Data",
"policyType": "NORMALIZED",
"retention": "6M",
"models": [
{
"modelId": "model_1",
"points": [
{
"pointId": "test_point1",
"sdt": {
"compdev": 0.22,
"compmax": 2200,
"compmin": 22
},
"db": {
"excdev": 0.11,
"excmax": 100,
"excmin": 11
}
},
{
"pointId": "test_point2",
"sdt": null,
"db": null
},
{
"pointId": "test_point3",
"sdt": {
"compdev": 0.22,
"compmax": 2200,
"compmin": 22
},
"db": null
}
]
},
{
"modelId": "model_2",
"points": [
{
"pointId": "test_point3",
"sdt": {
"compdev": 0.22,
"compmax": 2200,
"compmin": 22
},
"db": {
"excdev": 0.11,
"excmax": 1100,
"excmin": 11
}
}
]
}
]
}
}
Java SDK调用示例¶
import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envision.apim.poseidon.request.PoseidonRequest;
import org.junit.Before;
import org.junit.Test;
public class Sample {
private static final String APIM_BASE_URL = "https://{domain_url}";
private Poseidon poseidon;
@Before
public void init() {
poseidon = Poseidon.config(
PConfig.init()
.appKey("AccessKey of your APP")
.appSecret("SecretKey of your APP")
).method("GET");
}
@Test
public void GetStoragePolicyData() {
String policyId = "yourPolicyId";
String resp = poseidon.url(APIM_BASE_URL + "/tsdb-policy/v2.1/policies/" + policyId)
.queryParam("orgId", "yourOrgId")
.sync();
System.out.println(resp);
}
}