You need to enable JavaScript to run this app.
导航

GetAppList

最近更新时间2023.12.25 20:24:13

首次发布时间2022.11.25 11:53:32

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

使用说明

  • 接口名称:GetAppList
  • 请求方式:POST
  • 接口地址:/?Action=GetAppList&Version=2022-10-12

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

GetAppList

请求名称。

Version

String

2022-10-12

请求版本。

ServiceName : apmplus_openapi
Region : cn-beijing 
Content-Type : application/json

Body

参数

类型

是否必选

示例值

描述

aids

array of i64

[]

不传的时候查询用户所有App。

app_name

string

app_test

模糊查询app_name,可以不传。

page_no

i32

1

页号。

page_size

i32

10

每页项数。

返回参数

参数

类型

示例值

描述

data

object of data

-

应用列表。

error_msg

string

-

错误信息,成功为空。

error_no

i32

0

错误码,成功为0。

data

参数

类型

示例值

描述

result

array of result

-

应用列表。

total

i32

10

总应用数。

permission_service_keys

array of string

[app_monitor]

应用已开通的服务。

result

参数

类型

示例值

描述

aid

i64

12345

应用ID。

app_name

string

test_应用性能全链路监控

应用中文名。

app_en_name

string

test_apmplus

应用英文名。

icon_url

string

-

icon url。

app_token

string

-

默认返回最先创建的token,没有则为空。

create_time

i32

1666077679

应用创建时间。

accessable_services_map

map[string][]ServiceInstance

-

该应用已开通的产品,按service_key分组,多开需求之后的数据。

ServiceInstance

参数

类型

示例值

描述

service_key

string

app_monitor

服务类型。

aid

i64

123456

应用ID。

instance_status

string

expired

服务实例状态。

  • 正常
  • 超量
  • 超期
  • 关闭

pay_order_num

string

-

支付订单号。

preorder_nums

string

-

配置单号。

create_time

i64

1666077679

服务创建时间。

expire_time

i64

1666077679

服务到期时间。

created_by

string

test_user

服务创建人。

amount

i64

123

已用事件量。

total

i64

12345

总购买事件量。

请求示例

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]"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806*****22D30",
        "Action": "GetAppList",
        "Version": "2022-10-12",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}