查询标签列表
功能介绍
查询标签列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/tags
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
tag_name |
否 |
String |
标签名称 最大长度:256 |
limit |
否 |
Long |
分页查询时每页显示的记录数,默认值为10,取值范围为10-500的整数 最小值:10 最大值:500 缺省值:10 |
offset |
否 |
Long |
分页查询时的页码数,默认值为1,取值范围为1-1000000的整数 最小值:1 最大值:1000000 缺省值:1 |
status |
否 |
Integer |
标签状态,0未使用,1使用中。 最小值:0 最大值:1 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
limit |
Long |
每页记录数 |
offset |
Long |
页码 |
count |
Long |
记录总数 |
tags |
Array of CmTagVO objects |
标签记录 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最大长度:64 |
error_msg |
String |
错误描述 最大长度:512 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最大长度:64 |
error_msg |
String |
错误描述 最大长度:512 |
请求示例
查询标签列表,每页返回10条数据,从第1页开始。
GET https://{endpoint}/v1/tags?offset=1&limit=10
响应示例
状态码: 400
Bad Request
{ "error_code" : "GSL.00020004", "error_msg" : "参数异常" }
状态码: 500
Internal Server Error
{ "error_code" : "GSL.00020003", "error_msg" : "系统繁忙,请稍后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。