Get Asset

根据资产ID获取资产数据。

操作权限

需授权的资源

所需操作权限

资产

Read

请求格式

GET https://{apigw-address}/asset-service/v2.1/assets?action=get

请求参数(URI)

名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

资产所属的组织ID。如何获取orgId信息>>

assetId

Query

必需

String

资产ID。如何获取Asset ID信息>>

响应参数

名称

数据类型

描述

data

asset结构体

资产。见 asset结构体>>

asset结构体

名称

数据类型

描述

assetId

String

资产ID

orgId

String

资产所属的组织ID。

name

StringI18n

该资产的各语言名称。

description

String

资产描述

attributes

Map (Key为String, Value类型取决于模型定义)

资产所属的模型属性。

Key 为属性ID。 Value 为属性值。

timezone

String

时区

modelId

String

资产所属模型ID。

modelIdPath

String

模型继承路径。

例如:/Turbine/Double_Feed_Turbine

tags

Map(Key为String, Value为String)

用户自定义标签。

错误码

公共返回码

示例

请求示例

url: https://{apigw-address}/asset-service/v2.1/assets?action=get&orgId=yourOrgId&assetId=yourAssetId
method: GET

返回示例

{
  "msg": "OK",
  "code": 0,
  "data": {
    "modelId": "planet",
    "assetId": "TZ8AOlJU",
    "timezone": "+00:00",
    "name": {
      "i18nValue": {
        "en_US": "English name ",
        "zh_CN": "Chinese name"
                   },
      "defaultValue": "venus!"
            },
    "attributes": {
      "system": "Solar System"
                  },
    "modelIdPath": "/planet",
    "orgId": "yourOrgId",
    "description": null,
    "tags": {}
           },
  "requestId": "9a5cfbac-b2f8-4a37-b38d-8bccdd77d073"
}

Java SDK调用示例

public class GetAsset {
    private static String accessKey = "yourAppAccessKey";
    private static String secretKey = "yourAppSecretKey";
    private static String orgId = "yourOrgId";
    private static String url = "https://{apigw-address}";

    public static void main(String[] args) {
        GetAssetRequest request = new GetAssetRequest();
        request.setOrgId(orgId);
        request.setAssetId("XBOBqC1O");

        GetAssetResponse response = Poseidon.config(PConfig.init().appKey(accessKey)
                .appSecret(secretKey).debug())
                .url(url)
                .getResponse(request, request.getResponseClass());
        System.out.println(response.getCode());
    }
}