文档首页/ 智果(AgentArts)智能体平台/ API参考/ API/ 网关/ 网关标签管理/ 根据标签查询网关数量 - ShowCoreGatewayNumsByTags
更新时间:2026-07-17 GMT+08:00
分享

根据标签查询网关数量 - ShowCoreGatewayNumsByTags

功能介绍

根据标签查询网关数量。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

agentarts::listResourcesByTag

List

-

g:TagKeys

-

-

URI

POST /v1/gateways/resource-instances/count

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

参数解释:

是否查询所有不带标签的资源。

约束限制:

不涉及。

取值范围:

  • true:查询所有不带标签的资源,此时忽略 “tags”字段;

  • false:返回所有资源或按“tags”、“matches”等条件过滤。

默认取值:

false。

tags

Array of CoreGatewaysTagValuesForTMS objects

参数解释:

指定查询的资源中需要包含哪些标签,结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。

约束限制:

数组内key不能重复,同一个key中values不能重复,每个key对应的value可以为空数组但结构体不能缺失。

取值范围:

数组长度最大为20。

默认取值:

不涉及。

matches

Array of CoreGatewaysMatchForTMS objects

参数解释:

标签键值匹配字段,key为要匹配的字段。

约束限制:

key为固定字典值,只支持resource_name,不能包含重复的key或不支持的key。支持根据value的值做前缀搜索。

取值范围:

数组长度最大为1。

默认取值:

不涉及。

表2 CoreGatewaysTagValuesForTMS

参数

是否必选

参数类型

描述

key

String

参数解释:

标签键。

约束限制:

key不能为空或者空字符串,不能为空格。

取值范围:

最大长度128个unicode字符。

默认取值:

不涉及。

values

Array of strings

参数解释:

标签值列表。

约束限制:

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

取值范围:

数组长度0-20,每个值最大长度255个unicode字符。

默认取值:

不涉及。

表3 CoreGatewaysMatchForTMS

参数

是否必选

参数类型

描述

key

String

参数解释:

搜索字段,key为要匹配的字段。

约束限制:

当前只支持按照网关名称resource_name过滤资源。

取值范围:

固定为resource_name。

默认取值:

resource_name。

value

String

参数解释:

搜索匹配值,用于与网关名称做搜索。

约束限制:

支持前缀搜索,如果value为空字符串精确匹配(不存在资源名称为空的情况,因此此类情况会返回空列表)。

取值范围:

最大长度255个unicode字符。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

总记录数。

取值范围:

非负整数。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为1-32个字符。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为1-32个字符。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为1-32个字符。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

encoded_authorization_message

String

参数解释:

编码后的授权失败信息,可通过统一身份认证服务IAM的解密鉴权失败的原因接口解码获取详细授权失败原因。

取值范围:

取值为 1-4096 个字符。

details

Array of CoreGatewayCommonError objects

参数解释:

依赖的下游服务错误信息列表。

取值范围:

数组长度为 0-10。

表8 CoreGatewayCommonError

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为1-32个字符。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为1-32个字符。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:429

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为1-32个字符。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

状态码:500

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

取值为1-32个字符。

error_msg

String

参数解释:

错误消息。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_reason

String

参数解释:

错误原因。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

error_suggestion

String

参数解释:

错误处理建议。

取值范围:

取值为 1-256 个字符,匹配由字母、数字、空格、中文汉字以及常见中英文标点符号组成的非空字符串,符合正则条件^[a-zA-Z0-9\s\u4e00-\u9fff.,!?;:()''"-\u3002\uff0c\uff01\uff1f\uff1b\uff1a\uff08\uff09]+$。

请求示例

根据标签查询网关数量

POST https://{Endpoint}/v1/gateways/resource-instances/count

{
  "without_any_tag" : false,
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1" ]
  } ]
}

响应示例

状态码:200

根据标签查询网关数量成功。

{
  "total_count" : 1
}

状态码:400

请求参数错误

{
  "error_code" : "AgentArts.02000001",
  "error_msg" : "请求参数错误",
  "error_reason" : "请求参数错误",
  "error_suggestion" : "根据接口返回的具体原因修改请求参数"
}

状态码:401

认证信息无法识别

{
  "error_code" : "AgentArts.02000300",
  "error_msg" : "认证信息无法识别",
  "error_reason" : "认证信息无法识别",
  "error_suggestion" : "使用正确的认证信息访问"
}

状态码:403

权限不足,拒绝访问

{
  "error_code" : "AgentArts.02000200",
  "error_msg" : "没有权限执行该操作",
  "error_reason" : "没有权限执行该操作",
  "error_suggestion" : "请检查权限是否配置正确",
  "encoded_authorization_message" : "eyJlcnJvciI6ICJVbmF1dGhvcml6ZWQifQ==",
  "details" : [ {
    "error_code" : "IAM.0082",
    "error_msg" : "权限不足,拒绝访问"
  } ]
}

状态码:404

资源未找到

{
  "error_code" : "AgentArts.02000100",
  "error_msg" : "资源未找到",
  "error_reason" : "资源未找到",
  "error_suggestion" : "请检查对应资源是否存在"
}

状态码:429

请求频率超限。

{
  "error_code" : "AgentArts.02000400",
  "error_msg" : "请求过于频繁,请稍后重试",
  "error_reason" : "请求过于频繁,请稍后重试",
  "error_suggestion" : "稍后重试"
}

状态码:500

内部服务器错误。

{
  "error_code" : "AgentArts.02000500",
  "error_msg" : "服务连接超时",
  "error_reason" : "服务连接超时",
  "error_suggestion" : "请稍后重试"
}

状态码

状态码

描述

200

根据标签查询网关数量成功。

400

请求参数错误

401

认证信息无法识别

403

权限不足,拒绝访问

404

资源未找到

429

请求频率超限。

500

内部服务器错误。

错误码

请参见错误码

相关文档