查询预定义标签列表

功能介绍

用于查询预定义标签列表。

URI

GET /v1.0/predefine_tags

请求消息

• 要素说明

  表1 请求样例的要素说明

  名称	是否必选	参数类型	说明
  key	否	String	键，支持模糊查询，不区分大小写，如果包含“non-URL-safe”的字符，需要进行“urlencoded”。
  value	否	String	值，支持模糊查询，不区分大小写，如果包含“non-URL-safe”的字符，需要进行“urlencoded”。
  limit	否	Integer	查询记录数。 最小为1，最大为1000，未输入时默认为10，为0时不限制查询数据条数。
  marker	否	String	分页位置标识（索引）。 从marker指定索引的下一条数据开始查询。 说明： 查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据响应体中marker值配入此参数，当返回的tags为空列表时表示查询到最后一页。
  order_field	否	String	排序字段： 可输入的值包含（区分大小写）：update_time（更新时间）、key（键）、value（值）。 只能选择以上排序字段中的一个，并按照排序方法字段order_method进行排序，如果不传则默认值为：update_time。 如以下： 若该字段为update_time，则剩余两个默认字段排序为key升序，value升序。 若该字段为key，则剩余两个默认字段排序为update_time降序，value升序。 若该字段为value，则剩余两个默认字段排序为update_time降序，key升序。 若该字段不传，默认字段为update_time，则剩余两个默认字段排序为key升序，value升序。
  order_method	否	String	order_field字段的排序方法。 可输入的值包含（区分大小写）： asc（升序） desc（降序） 只能选择以上值的其中之一。 不传则默认值为：desc。

• 请求样例

  GET https://{TMS的Endpoint}/v1.0/predefine_tags?key=ENV&value=DEV&limit=10&marker=9&order_field=key&order_method=asc

响应消息

• 要素说明

  表2 响应样例的要素说明

  名称	参数类型	说明
  tags	Array of objects	标签列表。 详细参数请参见表3。
  total_count	Integer	总记录数，即符合过滤条件的标签个数，该记录数不受分页影响。
  marker	String	分页位置标识。 当前查询最后一条数据的索引位置。

• tags 字段数据结构说明

  表3 tags字段数据结构说明

  名称	参数类型	说明
  key	String	键。 最大长度36个字符。字符集：A-Z，a-z，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
  value	String	值。 每个值最大长度43个字符，可以为空字符串。字符集：A-Z，a-z，0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
  update_time	String	更新时间，采用UTC时间表示。如：2016-12-09T00:00:00Z。

• 响应样例

  状态码： 200

  操作成功

  {
      "marker": "12",
      "total_count": 13,
      "tags": [
          {
              "key": "ENV1",
              "value": "DEV1",
              "update_time": "2017-04-12T14:22:34Z"
          },
          {
              "key": "ENV2",
              "value": "DEV2",
              "update_time": "2017-04-12T14:22:34Z"
          }
      ]
  }

状态码

请参考状态码。

错误码

请参考错误码。