根据标签过滤查询评估器资源实例 - ListOpsEvaluatorsByTags
功能介绍
该接口用于根据标签过滤查询评估器资源实例列表,支持分页查询。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::listResourcesByTag | List | - | g:TagKeys | - | - |
URI
POST /v1/evaluators/resource-instances/filter
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 单次查询返回的最大记录数量。用于控制分页查询时每页显示的数据条数。 约束限制: 与offset参数配合使用实现分页查询。 取值范围: 1-1000。 默认取值: 100。 |
| offset | 否 | Integer | 参数解释: 分页查询的起始偏移量。用于指定从满足条件的第几条记录开始返回,常与 limit参数配合实现分页功能。 约束限制: 与limit参数配合使用实现分页查询。 取值范围: 0-10000。 默认取值: 0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| without_any_tag | 否 | Boolean | 参数解释: 是否查询未打标签的资源。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| tags | 否 | Array of OpsTmsTagFilter objects | 参数解释: 用户标签匹配条件列表。数组元素为OpsTmsTagFilter对象,包含key和values字段。最多包含20个key,每个key下最多20个value。Key不能重复,同一个key中values不能重复。key之间是与关系,key-value结构中value是或关系。无tag过滤条件时返回全量数据。value以*开头时使用LIKE模糊匹配(contains),否则使用精确匹配。 约束限制: 数组元素最大数量为20。 取值范围: 不涉及。 默认取值: 不涉及。 |
| sys_tags | 否 | Array of OpsTmsTagFilter objects | 参数解释: 系统标签匹配条件列表。数组元素为OpsTmsTagFilter对象,包含key和values字段。仅op_service权限可使用。与tags字段可同时使用(与关系),key之间是与关系,key-value结构中value是或关系。无sys_tags时按照仅tags条件处理。value以*开头时使用LIKE模糊匹配(contains),否则使用精确匹配。 约束限制: 数组元素最大数量为20。 取值范围: 不涉及。 默认取值: 不涉及。 |
| matches | 否 | Array of OpsTmsMatch objects | 参数解释: 标签匹配条件列表。数组元素为OpsTmsMatch对象,包含key和value字段。多个match之间为OR关系。key支持resource_name(前缀模糊匹配,空值精确匹配空串返回空列表)和resource_id(精确匹配,空值返回空列表)。 约束限制: 数组元素最大数量为20。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 否 | String | 参数解释: 标签键。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| values | 否 | Array of strings | 参数解释: 标签值列表,表示匹配该键下任意一个值的资源。数组元素为字符串类型,表示标签值。value以*开头时使用LIKE模糊匹配(contains),否则使用精确匹配。values为空列表时表示any_value(匹配该key下任意value)。 约束限制: 数组元素最小数量为0,最大数量为20。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resources | Array of OpsTmsResource objects | 参数解释: 符合标签过滤条件的资源列表。数组元素为OpsTmsResource对象,包含resource_id、resource_detail、resource_name、tags、sys_tags字段。 |
| total_count | Integer | 参数解释: 符合条件的资源实例总数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_id | String | 参数解释: 资源的唯一标识符。 取值范围: 不涉及。 |
| resource_detail | Object | 参数解释: 资源详细信息对象。 |
| tags | Array of OpsTmsTag objects | 参数解释: 资源绑定的自定义标签列表。数组元素为OpsTmsTag对象,包含key和value字段。 |
| sys_tags | Array of OpsTmsTag objects | 参数解释: 资源绑定的系统标签列表。数组元素为OpsTmsTag对象,包含key和value字段。 |
| resource_name | String | 参数解释: 资源名称。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键名称。 取值范围: 不涉及。 |
| value | String | 参数解释: 标签值,存储该标签键对应的具体内容。 取值范围: 由任意字符组成,长度为0~256个字符。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
请求示例
无
响应示例
状态码:200
无
状态码:400
{
"error_code" : "AgentArts.03400001",
"error_msg" : "请求错误"
} 状态码:401
{
"error_code" : "AgentArts.100004010",
"error_msg" : "unauthorized"
} 状态码:403
{
"error_code" : "AgentArts.100004030",
"error_msg" : "forbidden"
} 状态码:429
{
"error_code" : "AgentArts.100004290",
"error_msg" : "请求过于频繁"
} 状态码:500
{
"error_code" : "AgentArts.03500001",
"error_msg" : "internal error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 请求参数错误 |
| 401 | 认证失败 |
| 403 | 鉴权失败 |
| 429 | 请求过于频繁 |
| 500 | 系统错误 |
错误码
请参见错误码。