云数据库 GEMINIDB-查询资源实例:请求参数

时间:2023-11-22 09:18:52

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

offset

String

索引位置偏移量,表示从第一条数据偏移offset条数据后开始查询。

  • “action”值为“count”时,不传该参数。
  • “action”值为“filter”时,取值必须为数字,不能为负数。默认取0值,表示从第一条数据开始查询。'

limit

String

查询记录数。

  • “action”值为“count”时,不传该参数。
  • “action”值为“filter”时,取值范围:1~100。不传该参数时,默认查询前100条实例信息。

action

String

操作标识。

  • 取值为“filter”,表示根据标签过滤条件查询实例。
  • 取值为“count”,表示仅返回总记录数,禁止返回其他字段。

matches

Array of MatchOption objects

搜索字段。

  • 该字段值为空,表示不按照实例名称或实例ID查询。
  • 该字段值不为空。

tags

Array of TagOption objects

包含标签,最多包含20个key。

表4 MatchOption

参数

是否必选

参数类型

描述

key

String

取值为“instance_name”或“instance_id”,分别表示按实例名称或按实例ID匹配查询。

value

String

待匹配的实例名称或实例ID。

表5 TagOption

参数

是否必选

参数类型

描述

key

String

标签键。最大长度36个unicode字符,key不能为空或者空字符串,不能为空格,校验和使用之前先排除前后半角空格。

说明:

搜索时不对该参数做字符集校验。

values

Array of strings

标签值列表。最大长度43个unicode字符,不能为空格,校验和使用之前先排除前后半角空格。

如果values为空列表,则表示查询任意value。value之间为或的关系。

support.huaweicloud.com/api-nosql/ListInstancesByResourceTags.html