Get Assets by Application¶
查询当前用户在某个应用下有权限的所有资产。
请求参数(URI)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
accessKey | 必需 | String | 应用的服务账号,应用以 accessKey 进行鉴权以获得其被授权访问的数据。如何获取accessKey信息>> |
resourceTypes | 可选 | String | 按指定的资源类型过滤资源,支持输入最多 1000 种资源类型。 |
请求参数(Header)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
Authorization | 必需 | String | Access Token,以Bearer Token表示,其形式为`Bearer {your token}`,需要通过调用 Log In 或 Refresh Access Token 接口后获取 |
needAssociatedAsset | 可选 | Boolean | 返回组织结构节点关联的资源信息。true 为返回,false 为不返回。 |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | Data 结构体 | 资产列表 |
Data 结构体¶
名称 | 数据类型 | 描述 |
---|---|---|
id | String | 节点 ID |
name | String | 节点名称 |
tag | String | 节点标签,如果当前节点为资产,则标签为 asset,否则此节点为组织结构节点,对应标签为 null。(由于资产只能挂载到组织结构的叶子节点上,所以当此标签为 asset 时,必有父节点且父节点为组织结构节点,同时必然没有子节点) |
tags | List<StructureTagDTO> | 组织结构标签 |
displayOrder | Integer | 排序序号 |
nameJson | String | 域名称,多语言,json 结构 |
parentId | String | 父节点 ID |
data.type | String | 资源类型标识符。仅当前节点为资源节点时有效,若为组织结构节点时此值为 null。 |
data.typeName | I18nString | 资源类型名称。仅当前节点为资源节点时有效,若为组织结构节点时此值为 null。 |
children | Data 结构体 | 子节点 |
associatedResources | Data 结构体 | 节点关联的资源信息 |
错误码¶
代码 | 描述 |
---|---|
31400 | AccessKey 不能为空 |
31401 | 提供的 Access Token 无效 |
31403 | 没有此应用权限 |
31404 | 应用不存在或组织未获取此应用 |
31512 | 未选择 OU |
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.2/user/app/asset/tree?accessKey=your_access_key&resourceTypes=type1,type2
method: GET
headers: {"Authorization":"Bearer your_access_token"}
返回示例¶
{
"code": 0,
"data": {
"children": [
{
"children": [
{
"displayOrder": -1,
"id": "your_asset_id",
"name": "your_asset_name",
"nameJson": {
"default": "your_asset_name_default",
"en_US": "your_asset_name_en",
"zh_CN": "your_asset_name_zh",
"es_ES": "your_asset_name_es",
"ja_JP": "your_asset_name_jp"
},
"parentId": "",
"tag": "asset",
"type": "auth_unit",
"typeName": {"default":"your_asset_type_default","en_US":"your_asset_type_en","zh_CN":"your_asset_type_zh"}}
}
],
"displayOrder": 0,
"id": "your_asset_id",
"name": "your_asset_name",
"nameJson": {
"default": "your_asset_name_default",
"en_US": "your_asset_name_en",
"zh_CN": "your_asset_name_zh"
},
"parentId": "your_node_id",
"tags": [
{
"id": 123,
"key": "your_tag_key",
"value": "your_tag_value"
}
]
}
],
"displayOrder": 0,
"id": "your_asset_id",
"name": "your_asset_name",
"nameJson": {
"default": "your_asset_name_default",
"en_US": "your_asset_name_en",
"zh_CN": "your_asset_name_zh"
},
"parentId": "",
"tags": []
},
"message": "OK"
}