根据标签查询记忆库数量 - ShowCoreSpaceNumsByTags
功能介绍
该接口用于根据标签过滤条件查询记忆库的资源数量。
适用场景:
根据标签条件查找对应的记忆库的资源数量。
调用方法
请参见如何调用API。
URI
POST /v1/memory-space/resource-instances/count
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| without_any_tag | 否 | Boolean | 参数解释: 不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 "tags"、"tags_any"、"not_tags"、"not_tags_any"字段。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| tags | 否 | Array of CoreSpaceTagValuesForTMS objects | 参数解释: 包含标签。 最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。 结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。 无tag过滤条件时返回全量数据。 约束限制: Key不能重复,同一个key中values不能重复。 取值范围: 0-20个。 默认取值: 不涉及。 |
| matches | 否 | Array of CoreSpaceTagForTMS objects | 参数解释: 标签键值匹配规则,每个key对应的value可以为空数组但结构体不能缺失。key之间是与的关系,key-value结构中value是或的关系。无matches过滤条件时返回全量数据。 当matches和tags同时存在时,表示获取同时满足matches和tags的资源。 约束限制: Key不能重复,同一个key中values不能重复。 取值范围: 0-20个。 默认取值: 不涉及。 |
| tags_any | 否 | Array of CoreSpaceTagValuesForTMS objects | 参数解释: 包含任意标签。最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。 结果返回包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。 无过滤条件时返回全量数据。 约束限制: Key不能重复,同一个key中values不能重复。 取值范围: 0-20个。 默认取值: 不涉及。 |
| not_tags | 否 | Array of CoreSpaceTagValuesForTMS objects | 参数解释: 不包含标签。 最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。 结果返回不包含标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。 无过滤条件时返回全量数据。 约束限制: Key不能重复,同一个key中values不能重复。 取值范围: 0-20个。 默认取值: 不涉及。 |
| not_tags_any | 否 | Array of CoreSpaceTagValuesForTMS objects | 参数解释: 不包含任意标签。 最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。 结果返回不包含标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。 无过滤条件时返回全量数据。 约束限制: Key不能重复,同一个key中values不能重复。 取值范围: 0-20个。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签键。 约束限制: 不涉及。 取值范围: 最大长度128个unicode字符。key不能为空。(搜索时不对此参数做字符集校验),key不能为空或者空字符串,不能为空格。 默认取值: 不涉及。 |
| value | 是 | String | 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 每个值最大长度255个unicode字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签键。 约束限制: 不涉及。 取值范围: 长度1-128字符。 每个值最大长度255个unicode字符。最大长度128个unicode字符。key不能为空。key不能为空或者空字符串,不能为空格。可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @。 默认取值: 不涉及。 |
| values | 是 | Array of strings | 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 0-20个。 每个值最大长度255个unicode字符。可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: 总记录数。 取值范围: 1-20 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权失败信息。 取值范围: 不涉及。 |
| details | Array of CoreSpaceCommonError objects | 参数解释: 依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
请求示例
根据标签精确查询资源数量
/v1/memory-space/resource-instances/count
{
"tags" : [ {
"key" : "tag",
"values" : [ "tag_value" ]
} ]
} 响应示例
状态码:200
根据标签查询记忆库数量成功。
{
"total_count" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 根据标签查询记忆库数量成功。 |
| 400 | 请求参数错误。 |
| 401 | 认证失败。 |
| 403 | 权限不足。 |
| 404 | 记忆库未找到 |
| 429 | 请求频率超限。 |
| 500 | 内部服务器错误 |
错误码
请参见错误码。