【旧版】标签列表 ListTag--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】标签列表 ListTag

最近更新时间：2024.06.17 19:36:21首次发布时间：2023.06.14 12:45:19

查询业务下创建的标签列表信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	ListTag
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01
product_id	Query	string	是	业务 ID	例：client-demo
tag_name	Query	string	否	筛选条件，标签名称，精确搜索
tag_name_fuzzy	Query	string	否	筛选条件，标签名称，模糊搜索
offset	Query	int64	否	筛选条件，分页参数
count	Query	int64	否	筛选条件，分页参数

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
total	int	查询结果总量
row	`List<Tag>`	查询到的标签信息列表，详细信息，参考 Tag 定义

示例

请求示例

GET https://open.volcengineapi.com?Action=ListTag
&Version=2022-08-01
&product_id=1608456935646xxxxxx
&tag_name_fusszy=test
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListTag",
        "Region": "cn-north-1",
        "RequestId": "2023113014524984BFE772DC7B1982CE39",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "row": [
            {
                "tag_id": "7269751760565xxxxxx",
                "tag_name": "test10",
                "pod_num": 0,
                "product_id": "1608456935646xxxxxx",
                "tag_desc": ""
            },
            {
                "tag_id": "7269751760565xxxxxx",
                "tag_name": "test11",
                "pod_num": 0,
                "product_id": "1608456935646xxxxxx",
                "tag_desc": ""
            }
        ],
        "total": 2
    }
}