Retrieve Purchased Apps


根据应用标识或 accessKey 查询已获取的应用。

操作权限


应用被授权 OU 的应用注册管理员策略。

请求格式


GET https://{apigw-address}/enos-app-service/v2.5/apps/purchase/retrieve

请求参数(URI)


名称 位置(Path/Query) 必需/可选 数据类型 描述
orgId Query 必需 String 应用所属的 OU ID。如何获取 orgId 信息 >>
key Query 可选 String 应用标识(keyword)或 accessKey。
appId Query 可选 String 应用 ID。若同时提供 appIdkey,将优先使用 appId

响应参数


名称 数据类型 描述
id String 应用 ID,由系统自动生成的唯一标识。
accessKey String 应用的 accessKey。
secretKey String 应用的 secretKey。
name StringI18n 应用的名称。
description StringI18n 应用的描述。
categoryId String 应用分类的 ID。
categoryName StringI18n 应用分类的名称。
keyword String 应用标识,自定义的应用唯一标识。
type String 应用类型。
icon String 应用的图标。
url String 应用的 URL。
organizationId String 应用所属的 OU ID。
organizationName String 应用所属的 OU 名称。
createdByUserId String 应用的创建人 ID。
createdAt String 应用的创建时间。
status String 应用的状态,固定为 2,表示已获取。
createdByUserName String 应用的创建人名称。
approvedAt String 应用获取请求审批通过的时间。

示例

请求示例


url: https://{apigw-address}/enos-app-service/v2.5/apps/purchase/retrieve?orgId=yourOrgId&key=yourAppKey
method: GET

返回示例


{
  "code": 0,
  "msg": "OK",
  "subMsg": null,
  "data": {
    "id": "abc-applicationID-xyz",
    "accessKey": "accesskey-application",
    "secretKey": "secretkey-application",
    "name": {
      "default": "Energy Management",
      "en_US": "Energy Management",
      "zh_CN": "能源管理应用"
    },
    "description": {
      "default": "Energy Management",
      "en_US": "Energy Management",
      "zh_CN": "能源管理应用"
    },
    "keyword": "energy-management",
    "categoryId": 101,
    "categoryName": {
      "pl_PL": "",
      "en_US": "Storage",
      "es_ES": "",
      "zh_CN": "储能",
      "fr_FR": "",
      "ja_JP": "",
      "de_DE": ""
    },
    "type": 0,
    "icon": "",
    "url": "",
    "organizationId": "yourorgId",
    "organizationName": "Your OU Name",
    "createdByUserId": "abc-userID-xyz",
    "createdAt": "2024-01-19 08:40:45",
    "status": 2,
    "createByUserName": null,
    "approvedAt": null
  }
}