查询用户属性列表 ListUserTag--云游戏-火山引擎

文档中心

立即注册

导航

查询用户属性列表 ListUserTag

最近更新时间：2025.09.15 16:05:13首次发布时间：2022.03.01 17:31:35

查询用户属性列表。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListUserTag&Version=2022-02-10

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListUserTag
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-02-10
offset	Query	Int64	否	分页偏移量	例：0
count	Query	Int64	否	单页数量	默认值：10

返回结果

通用返回参数，参考 ResponseMetadata 结构说明。
Result 字段包含以下参数：

字段	类型	说明
total	Int64	查询到的用户属性总数
row	`List<UserTag>`	用户属性列表

示例

请求示例

GET https://open.volcengineapi.com?Action=ListUserTag
&Version=2022-02-10
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListUserTag",
        "Region": "cn-north-1",
        "RequestId": "202203011603230102121620310B096949",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "row": [
            {
                "user_tag": "user_group_01"
            },
            {
                "user_tag": "user_group_02"
            },
            {
                "user_tag": "user_group_03"
            }
        ],
        "total": 3
    }
}