# 根据关键字一键刷新 - RefreshScriptFromAwFilter #### 功能介绍 根据关键字信息查询所有关联的用例、组合关键字 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v1/{project_id}/basic-aw/refresh-to-all/filter 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **约束限制**: 不涉及 **取值范围**: 项目uuid应符合如下规则：长度等于32位字符，包含大小写字母、数字 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | aw_id | 是 | String | **参数解释** 关键字id **约束限制** 不涉及 **取值范围** 32个字符组成的字符串 **默认取值** 不涉及 **获取方法** 查看关键字信息，从接口GET /v3/{project_id}/basic-aw/{aw_id} 请求地址中获取aw_id对应的值 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | aw_filter | 否 | Array of strings | 关键字过滤条件 | | instance_filter | 否 | Array of [FilterCondition] objects | 实例过滤条件 | | is_refresh_combinedaw | 否 | Boolean | 是否刷新组合关键字 | | is_refresh_logiccase | 否 | Boolean | 是否刷新逻辑用例 | | iterator_uri | 否 | String | 迭代版本Uri, 非基线场景下一键刷新使用 | | page_no | 否 | Integer | **参数解释** 分页页码 **约束限制** 不涉及 **取值范围** 0-999999999 **默认取值** 不涉及 | | page_size | 否 | Integer | **参数解释** 分页大小 **约束限制** 不涉及 **取值范围** 0-100 **默认取值** 不涉及 | | page_type | 否 | Integer | 分页类型 - -1,都查 - 0,查用例 - 1.查组合关键字 | | search_key | 否 | String | 搜索关键字 | | testcase_uri_list | 否 | Array of strings | 测试用例的Uri列表 | 表5FilterCondition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | field | 否 | Integer | 过滤字段0-parameter/1-checkpoint/2-variables | | key | 否 | String | 过滤字段为0时有效,代表参数名 | | value | 否 | String | 参数值/过滤json/过滤json | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 接口调用失败错误码 **取值范围** 不超过256个字符组成的字符串 | | error | [CommonResponseErrorObject] object | **参数解释** 统一错误返回 **取值范围** 不涉及 | | reason | String | **参数解释** 接口调用失败原因 **取值范围** 不超过1000个字符组成的字符串 | | result | Object | **参数解释** 结果 **取值范围** 不涉及 | | status | String | **参数解释** '状态值，如success、error' **取值范围** - success，请求成功 - error，请求报错 | 表7CommonResponseErrorObject | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 接口调用失败错误码 **取值范围** 不超过256个字符组成的字符串 | | reason | String | **参数解释** 接口调用失败原因 **取值范围** 不超过1000个字符组成的字符串 | **状态码：201** Created **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | **状态码：404** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | #### 请求示例 ``` { "testcase_uri_list" : null, "is_refresh_combinedaw" : true, "is_refresh_logiccase" : true, "instance_filter" : null } ``` #### 响应示例 **状态码：200** OK ``` { "status" : "ok", "result" : { "progress" : { "id" : "d05d88374c0c48a1a808dfeb49dbe14b", "rate" : 16, "message" : "搜索过滤用例信息..." } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 201 | Created | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。