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

SessionList

最近更新时间2023.12.26 18:54:56

首次发布时间2022.11.18 15:32:34

调用SessionList接口获取指定session下的trace详情。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

SessionList

请求名称。

Version

String

2022-10-12

请求版本。

ServiceName : apmplus_openapi
Region : cn-beijing 
X-App-Ids : xxx
Content-Type : application/json

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

时间区间。

slardar_session_id

string

452551f8-xxx-9d50078ennb6

session_id,可从DataList接口获取。

timestamp

i32

1668576681

session开始的时间戳,可从DataList接口获取。

next_key

string

-

每次请求最多只返回200条,超过200条会返回next_key,下一次请求附上next_key,从next_key处再返回200条。

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

返回参数


请求示例

POST https://open.volcengineapi.com/?Action=SessionList&Version=2022-10-12 
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "user": "test_user",
        "os": "webpro"
    },
    "slardar_session_id": "452551f8-xxx-9d50078ennb6",
    "timestamp": 1668576681,
    "next_key": ""
}

返回示例

正常返回示例

{
    "error_no": 0,
    "data": {
        "table_list": [
            {
                "metric_map": "{\"browser_brand\":{\"value\":\"Chrome\",\"label\":\"browser_brand\",\"groupKey\":\"\",\"groupName\":\"\"},\"fcp\":{\"value\":\"1109.6\",\"label\":\"首次有内容渲染时间(FCP)\",\"unit\":\"ms\",\"groupKey\":\"\",\"groupName\":\"\"}",
                "ev_type": "session",
                "json": ""
            }
        ],
        "next_key": ""
    },
    "error_msg": ""
}

异常返回示例

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