查询Runtime资源实例数量 - ShowCoreRuntimeNumsByTags
功能介绍
该接口用于根据标签过滤条件查询智能体运行时的资源数量。
适用场景:
根据标签条件查找对应的智能体运行时资源数量。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::listResourcesByTag | List | - | g:TagKeys | - | - |
URI
POST /v1/runtimes/resource-instances/count
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| without_any_tag | 否 | Boolean | 参数解释: 是否查询所有不带标签的资源。 约束限制: 不涉及。 取值范围: 默认取值: false |
| tags | 否 | Array of CoreRunTagValuesForTMS objects | 参数解释: 指定查询的资源中需要包含哪些标签。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。 约束限制: Key不能重复,同一个key中values不能重复,每个key对应的value可以为空数组但结构体不能缺失。 取值范围: 最多包含20个key,每个key下面的value最多20个。 默认取值: 不涉及,无tag过滤条件时返回全量数据。 |
| matches | 否 | Array of CoreRunTagForTMS objects | 参数解释: 搜索字段,key为要匹配的字段,当前只支持resource_name,即根据运行时名称进行过滤。key固定填写resource_name,value为运行时的名称。支持根据value的值做前缀搜索。 约束限制: key为固定字典值,只支持resource_name,不能包含重复的key或不支持的key。 取值范围: 最多包含20个key。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签键。 约束限制: 不涉及。 取值范围: 最大长度128个unicode字符,key不能为空或者空字符串,不能为空格。 默认取值: 无。 |
| values | 是 | Array of strings | 参数解释: 标签值列表,如果values为空列表,则表示any_value(查询任意value)。value之间为或的关系。 约束限制: 不涉及。 取值范围: 最小数量 1,最大数量 20,每个值最大长度255个unicode字符。 默认取值: 无。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 每个值最大长度255个unicode字符,可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符:_ . : / = + - @。 默认取值: 不涉及。 |
| value | 是 | String | 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 每个值最大长度255个unicode字符,可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符:_ . : / = + - @。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: 根据标签查询运行时访问方式资源的数量总记录数。 取值范围: 0 - 20 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000400表示客户端请求参数错误。 取值范围: 固定值:AgentArts.03000400。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为1-512个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000401表示未授权(认证令牌缺失、无效或已过期)。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000403表示禁止访问(认证后权限不足)。 取值范围: 固定值:AgentArts.03000403。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
| coded_authorization_message | String | 参数解释: IAM5 当OpenAPI无权限时报错信息。 取值范围: 长度为 1 - 1024 个字符。 |
| details | Array of CoreRunErrorDetail objects | 参数解释: 依赖的下游服务错误信息列表。 取值范围: 最小数量 0,最大数量 10。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 长度为 18 个字符。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 长度为 1 - 1024 个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000404表示资源不存在。 取值范围: 固定值:AgentArts.03000404。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000429表示请求过于频繁(触发限流)。 取值范围: 固定值:AgentArts.03000429。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。枚举值说明:AgentArts.03000500表示服务器内部错误。 取值范围: 固定值:AgentArts.03000500。 |
| error_msg | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
请求示例
根据标签精确查询资源数量
POST https://{Endpoint}/v1/runtimes/resource-instances/count
{
"tags" : [ {
"key" : "tag",
"values" : [ "tag_value" ]
} ]
} 响应示例
状态码:200
根据标签查询Runtime数量成功。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 根据标签查询Runtime数量成功。 |
| 400 | 请求参数错误。 |
| 401 | 未授权(认证令牌缺失、无效或已过期)。 |
| 403 | 禁止访问(认证后权限不足)。 |
| 404 | 资源不存在。 |
| 429 | 请求过于频繁(触发限流)。 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。