应用信息 OpenAPI--增长分析（私有化）-火山引擎

文档中心

立即注册

导航

应用信息 OpenAPI

最近更新时间：2024.05.29 16:21:47首次发布时间：2023.03.20 20:33:42

1.概述

本文档提供查询应用、项目、集团等相关信息的接口说明。
注：私有化4.4版本（含）后支持。

2.API 公共参数

Context-path: /datafinder

3.获取集团信息

3.1 API 定义

Path：openapi/v1/orgs/{org_id}
Method:GET
Content-type: application/json
Body: 参考公共参数说明

Response:

{
    "code": 200,
    "message": "success",
    "data": [
       
        {
            "org_id": 2100230837,
            "org_name": "Demo体验",
            "is_admin": false,
            "apps": [
                {
                    "project_id": 2111833,
                    "project_name": "e-commerce-demo",
                    "project_display_name": "电商demo",
                    "role": "member",
                    "app_id": 20000341,
                    "app_name": "电商demo"
                }
            ]
        }
    ]
}

字段含义说明

Field	Type	Description
org_id	int	集团id
org_name	str	集团名称
is_admin	bool	是否为管理员
apps	list	应用信息

app信息相关：

Field	Type	Description
app_id	int	应用id
app_name	str	应用名称
app_en_name	str	应用英文名称
project_id	int	项目id *仅云原生版本提供该字段
project_name	str	项目名 *仅云原生版本提供该字段
project_display_name	str	项目展示名 *仅云原生版本提供该字段
role	str	角色 *仅云原生版本提供该字段

3.2 OpenAPI SDK 使用样例

bc 为创建的 RangersClient, 其初始化请参考 “OpenAPI SDK 使用说明”，各语言的 SDK 都提供了类似的接口

调用(Python)：

res = bc.data_finder('/openapi/v1/orgs/10052')
print(res.content)

返回结果：

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "org_id": 10052,
            "org_name": "test_role",
            "apps": [
                {
                    "app_id": 374683,
                    "app_name": "test_role",
                    "app_en_name": "test_role"
                }
            ]
        }
    ]
}