查询标签列表 ListTag--云手机-火山引擎

文档中心

立即注册

导航

云手机

查询标签列表 ListTag

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.03.04 19:40:02

此接口用于查询业务下创建的标签列表信息。

注意事项

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListTag&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListTag`	接口名称。当前 API 的名称为 `ListTag`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1608456935646xxxxxx`	业务 ID，可在云手机控制台 > 业务管理 > 业务详情中获取。
TagName	String	否	`test01`	筛选条件，标签名称，精确搜索。
TagNameFuzzy	String	否	`01`	筛选条件，标签名称，模糊搜索。
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Row	Array of Tag	`-`	查询到的标签信息列表。
Total	Long	`1`	查询结果总量。

Tag

参数	类型	示例值	描述
TagId	String	`tag01`	标签 ID，全局唯一。
PodNum	Long	`1`	标签关联的实例数量。
TagDesc	String	`tag01`	标签描述。
TagName	String	`标签01`	标签名称，全局唯一。
ProductId	String	`1591495366954xxxxxx`	业务 ID。

请求示例

GET https://open.volcengineapi.com?Action=ListTag&Version=2023-10-30&ProductId=1608456935646xxxxxx&TagNameFuzzy=test&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023060411042***0232280022D31",
        "Action": "ListTag",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "Row": [
            {
                "PodNum": 4,
                "ProductId": "1608456935646xxxxxx",
                "TagDesc": "游戏应用",
                "TagId": "7269751760565xxxxxx",
                "TagName": "test10"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。