You need to enable JavaScript to run this app.
导航
GetAppList
最近更新时间:2024.06.20 17:40:46首次发布时间:2022.11.25 11:53:32

调用GetAppList接口获取应用列表。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=GetAppList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing 
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionStringGetAppList接口名称。当前 API 的名称为 GetAppList
VersionString2022-10-12接口版本。当前 API 的版本为 2022-10-12

Body

参数类型是否必选示例值描述
aidsArray of Long[]不传的时候查询用户所有App。
app_nameStringapp_test模糊查询app_name,可以不传。
page_noInteger1页号。
page_sizeInteger10每页项数。

返回参数

参数类型示例值描述
dataObject of ListAppData-应用列表。
error_msgString""错误信息,成功为空。
error_noInteger0错误码,成功为0。

ListAppData

参数类型示例值描述
totalInteger10总应用数。
resultArray of App-应用列表。
permission_service_keysArray of String[app_monitor]应用已开通的服务。

App

参数类型示例值描述
aidLong123456应用ID。
app_nameStringtest_应用性能全链路监控应用中文名。
app_en_nameStringtest_apmplus应用英文名。
icon_urlString-icon url。
app_tokenString-默认返回最先创建的token,没有则为空。
create_timeInteger1666077679应用创建时间。
accessable_services_mapJSON Map-该应用已开通的产品,按service_key分组,多开需求之后的数据。

Accessable_services_map

参数类型示例值描述
keyStringapp_monitor该应用已开通的产品。
valueArray of ServiceInstancetest产品对应的value。

ServiceInstance

参数类型示例值描述
service_keyStringapp_monitor服务类型。
aidLong123456应用ID。

instance_status

String

expired

服务实例状态。

  • normal:正常
  • overrange:超量
  • expired:超期
  • closed:关闭
pay_order_numString3252617*******支付订单号。
preorder_numsString1234567*******配置单号。
create_timeLong1666077679服务创建时间。
expire_timeLong1666077679服务到期时间。
created_byStringtest_user服务创建人。
amountLong123已用事件量。
totalLong12345总购买事件量。

请求示例

POST https://open.volcengineapi.com?Action=GetAppList&Version=2022-10-12
{
    "page_no": 1,
    "page_size": 10,
    "aids": [],
    "app_name": "app_test"
}

返回示例

{
    "error_no": 0,
    "error_msg": "",
    "data": {
        "result": [
            {
                "icon_url": "",
                "id": 1122334,
                "app_type": "",
                "app_key": "",
                "aid": 123456,
                "app_name": "test_应用性能全链路监控",
                "app_en_name": "test_apmplus",
                "create_time": 1666077679
            }
        ],
        "total": 10,
        "permission_service_keys": "[app_monitor]"
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码