# 新增接口 - AddAPIUsingPOST #### 功能介绍 根据接口信息 新增接口 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v2/{project_id}/basic-aw 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **约束限制**: 不涉及 **取值范围**: 项目uuid应符合如下规则：长度等于32位字符，包含大小写字母、数字 **默认取值**: 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | body_param_type | 否 | String | **参数解释** 关键字实例的参数body体类型 **取值范围** - form - text | | description | 否 | String | 描述 | | dft_check_point_list | 否 | Array of [CheckPoint] objects | **参数解释** 检查点集合 | | dft_custom_header | 否 | Array of [AwParam] objects | **参数解释** 默认请求头参数对象 | | dft_variable_list | 否 | Array of [AwVariable] objects | **参数解释** 定义的变量信息 | | extra_info | 否 | [ExtraInfo] object | 补充信息 | | group_name | 否 | String | **参数解释** 分组名 **取值范围** 不超过50个字符组成的字符串 | | name | 否 | String | **参数解释** 名称 **取值范围** 不超过300个字符组成的字符串 | | param_type_and_dft_value | 否 | Array of [AwParam] objects | **参数解释** 参数类型和参数默认值对应集合 | 表4CheckPoint | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | comparison | 否 | String | **参数解释** 比较符 **取值范围** 不涉及 | | description | 否 | String | **参数解释** 描述信息 | | function_arg | 否 | String | **参数解释** 类型值 **取值范围** 不涉及 | | function_type | 否 | String | **参数解释** 高级提取类型 **取值范围** - REGEX,正则表达式 - SUBSTRING, 字符串截取 | | property | 否 | String | **参数解释** 属性 **取值范围** 不涉及 | | value | 否 | String | **参数解释** 目标值 | 表5ExtraInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | childImportPackage | 否 | Array of strings | **参数解释** 子级导入的包 **取值范围** 不涉及 | | document_link | 否 | String | **参数解释** 文档链接 **取值范围** 不超过300个字符组成的字符串 | | http_method | 否 | String | **参数解释** http请求方法 **取值范围** - get - post - put - delete | | http_url | 否 | String | **参数解释** HTTP请求的URL **取值范围** 不涉及 | | importPackage | 否 | Array of strings | **参数解释** 导入的包 **取值范围** 不涉及 | | mock | 否 | [MockInfo] object | **参数解释** 关键字实例中的mock信息 **取值范围** 不涉及 | | outputParam | 否 | Array of [AwVariable] objects | **参数解释** 输出参数 **取值范围** 不涉及 | | param_dependent | 否 | String | **参数解释** 参数依赖 **取值范围** 不涉及 | | summary | 否 | String | **参数解释** 摘要 **取值范围** 不涉及 | 表6AwVariable | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | by_order | 否 | Integer | **参数解释** 节点顺序 **取值范围** 0-9999 | | currentPermission | 否 | String | **参数解释** 当前用户权限 **取值范围** 不涉及 | | description | 否 | String | **参数解释** 参数描述 | | dynamicParam | 否 | String | **参数解释** 动态参数名称 **取值范围** 不涉及 | | dynamicParamFlag | 否 | Boolean | **参数解释** 动态参数标志,默认为false. true代表动态参数; false代表非动态参数 | | functionParams | 否 | String | **参数解释** 变量参数（\[\]:空参、\[a\]:一参，\[a,b\]:两参） **取值范围** 不涉及 | | function_arg | 否 | String | **参数解释** 提取类型的类型值 **取值范围** 不涉及 | | function_type | 否 | String | **参数解释** 高级提取类型，响应提取时要使用什么方法处理参数 **取值范围** - REGEX, 正则表达式 - SUBSTRING, 字符串截取 | | isSensitiveInfo | 否 | Boolean | **参数解释** 是否是敏感字段 **取值范围** - true, - false | | isSensitiveModified | 否 | Boolean | **参数解释** 敏感字段是否被修改，不敏感字段不关注此值 | | is_out_put | 否 | Boolean | **参数解释** 是否是组合关键字的输出参数，只有组合关键字下awInstance的关键字变量有该字段 | | name | 否 | String | **参数解释** 参数名称 **取值范围** 不超过300个字符组成的字符串 | | node_id | 否 | String | **参数解释** 节点唯一标识 **取值范围** 32个字符组成的字符串 | | node_type | 否 | Integer | **参数解释** 节点类型 **取值范围** - 0,变量节点 - null,变量节点 - 1,目录节点 | | oldName | 否 | String | **参数解释** 旧名称 **取值范围** 不涉及 | | parent_node_id | 否 | String | **参数解释** 父节点唯一标识 **取值范围** 32个字符组成的字符串 | | property | 否 | String | **参数解释** 属性 **取值范围** 不涉及 | | regex | 否 | String | **参数解释** 内置函数枚举 **取值范围** 不涉及 | | sensitiveInfoSetterTime | 否 | String | **参数解释** 敏感参数设置时间 **取值范围** 不涉及 | | sensitiveInfoSetterUser | 否 | String | **参数解释** 敏感参数设置者名称 **取值范围** 不涉及 | | type | 否 | String | **参数解释** 类型 **取值范围** - String - boolean - int - Integer - integer - float - short - double - long - BigDecimal - Object - ObjectNode - ArrayNode - file,file不是java的File类型，实际是String类型，传的文件路径 - List\[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br\] - Json - JsonNode | | variableType | 否 | Integer | **参数解释** 变量类型（0：text，10-16：分别对应7个内置函数） **取值范围** - 10,任意长度随机字符串 - 11,指定范围随机int - 12,生成当前整数时间戳（从1970-01-01 00:00 UTC开始的秒数) - 13,按照指定的format格式化时间戳，如 $timestamp_format(timestamp, YYYY-MM-DD) - 14,生成UUID - 15,使用Base64方法编码参数 - 16,使用指定参数生成MD5哈希值 - 18,sha512编码参数 | 表7AwParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | basic_value | 否 | [AwParamBasicValue] object | **参数解释** 关键字参数基本类型取值类 **取值范围** 不涉及 | | basic_value_list | 否 | Array of [AwParamBasicValue] objects | **参数解释** 关键字参数, valueType为1时该值有效 **取值范围** 不涉及 | | custom_body | 否 | String | **参数解释** 自定义requestBody内容,inType为2且isBodyCustom为1时有效 **取值范围** 不涉及 | | defaultValue | 否 | String | **参数解释** 默认值 **取值范围** 不涉及 | | description | 否 | String | **参数解释** 关键字参数描述 **取值范围** 不超过3000个字符组成的字符串 | | disabled | 否 | Boolean | **参数解释** 是否禁用,只有非必需参数才能被禁用 **取值范围** - true - false | | drop_down_value | 否 | String | **参数解释** 用于存储下拉菜单的值 **取值范围** 不涉及 | | enum_type | 否 | String | **参数解释** 枚举类型 **取值范围** - 0,基本类型 - 1,基本类型数组 - 2,结构体 - 3,结构体数组 - 5,枚举，下拉框展示 - 6,枚举，单选框展示 - 7,下拉框 - 8,单选按钮 - 9,公共的 | | enum_type_selected | 否 | String | **参数解释** 当前选中的枚举类型 **取值范围** - 0,基本类型 - 1,基本类型数组 - 2,结构体 - 3,结构体数组 - 5,枚举，下拉框展示 - 6,枚举，单选框展示 - 7,下拉框 - 8,单选按钮 - 9,公共的 | | format | 否 | String | **参数解释** num和String有效 **取值范围** 不涉及 | | in_type | 否 | Integer | **参数解释** rest接口输入参数类型 **取值范围** - 0,query - 1,path - 2,body - 3,header - 4,formdata - 5,config | | isChecked | 否 | Boolean | **参数解释** 是否是被选中参数 **取值范围** - true - false | | is_big_field | 否 | Boolean | **参数解释** 是否是大字段参数 **取值范围** - true - false | | is_body_custom | 否 | Integer | **参数解释** requestBody是否自定义，inType为2时有效。0-非自定义，用原有逻辑；1-自定义body,requestBody直接使用字段customBody **取值范围** - 0,非自定义 - 1,自定义body | | is_contract_param | 否 | Integer | **参数解释** 是否是契约关键字 **参数解释** - 0, 否 - 1, yes | | is_sensitive | 否 | Boolean | **参数解释** 是否敏感参数 **参数解释** - 0,是 - 1,不是 | | item | 否 | [ItemParam] object | **参数解释** 关键字基本参数 **参数解释** 不涉及 | | maxItems | 否 | Integer | **参数解释** Array类型最大元素数 **取值范围** 不涉及 | | maxLength | 否 | Long | **参数解释** String类型最大长度 **取值范围** 不涉及 | | maximum | 否 | Object | **参数解释** Number类型最大值 **取值范围** 不涉及 | | minItems | 否 | Integer | **参数解释** Array类型最小元素数 **取值范围** 不涉及 | | minLength | 否 | Long | **参数解释** String类型最小长度 **取值范围** 不涉及 | | minimum | 否 | Object | **参数解释** Number类型最小值 **取值范围** 不涉及 | | mock | 否 | [MockInfo] object | **参数解释** 关键字实例中的mock信息 **取值范围** 不涉及 | | name | 否 | String | **参数解释** 参数名 **取值范围** 不超过300个字符组成的字符串 | | object_value | 否 | Array of [AwParam] objects | **参数解释** valueType为2时该值有效。valueType为3时，该值用来表示数组中单个结构体 **取值范围** 不涉及 | | object_value_list | 否 | Array\\> | **参数解释** valueType为3时该值有效 **取值范围** 不涉及 | | pattern | 否 | String | **参数解释** num和String有效 **取值范围** 不涉及 | | required | 否 | Boolean | **参数解释** 是否必需参数 **取值范围** - true - false | | type | 否 | String | **参数解释** 参数类型 **取值范围** - String - boolean - int - Integer - integer - float - short - double - long - BigDecimal - Object - ObjectNode - ArrayNode - file,file不是java的File类型，实际是String类型，传的文件路径 - List\[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br\] - Json - JsonNode | | validate_rule | 否 | [ValidateRule] object | **参数解释** 校验规则 **取值范围** 不涉及 | | value_type | 否 | Integer | **参数解释** 参数值类型 **取值范围** - 0, 基本类型，type字段为String,Integer等基本类型 - 1, type字段为List\[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br\],List\[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br\]等基本类型List - 2, 结构体，type字段为除了基本类型以外的结构体 - 3, 结构体数组，type字段为List\<结构体\> - 5, 枚举类型，TCP协议测试引入 | | xChoiceValue | 否 | String | **参数解释** choice选择关系 **取值范围** 不涉及 | 表8AwParamBasicValue | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | value | 否 | String | **参数解释** 参数默认值，用例有效 | | value_range | 否 | String | **参数解释** 参数值范围，逻辑用例有效 | 表9ItemParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | basic_value | 否 | [AwParamBasicValue] object | **参数解释** 关键字参数基本类型取值类 | | defaultValue | 否 | String | **参数解释** 默认值 **取值范围** 不涉及 | | enum_type | 否 | String | **参数解释** 枚举类型 | | enum_type_selected | 否 | String | **参数解释** 当前选中的枚举类型 | | format | 否 | String | **参数解释** num和String有效 | | is_big_field | 否 | Boolean | **参数解释** 是否是大字段参数 | | maxItems | 否 | Integer | **参数解释** Array类型最大元素数 | | maxLength | 否 | Long | **参数解释** String类型最大长度 | | maximum | 否 | Object | Number类型最大值 | | minItems | 否 | Integer | **参数解释** Array类型最小元素数 | | minLength | 否 | Long | **参数解释** String类型最小长度 | | minimum | 否 | Object | **参数解释** Number类型最小值 | | pattern | 否 | String | **参数解释** num和String有效 | | type | 否 | String | **参数解释** 参数类型 - String - boolean - int - Integer - integer - float - short - double - long - BigDecimal - Object - ObjectNode - ArrayNode - file,file不是java的File类型，实际是String类型，传的文件路径 - List\[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br\] - Json - JsonNode | | validate_rule | 否 | [ValidateRule] object | **参数解释** 校验规则 | | value_type | 否 | Integer | **参数解释** 参数值类型 - 0, 基本类型，type字段为String,Integer等基本类型 - 1, type字段为List\[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br\],List\[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br\]等基本类型List - 2, 结构体，type字段为除了基本类型以外的结构体 - 3, 结构体数组，type字段为List\<结构体\> - 5, 枚举类型，TCP协议测试引入 | | xChoiceValue | 否 | String | **参数解释** choice选择关系 | 表10MockInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | mock_id | 否 | String | **参数解释** mock唯一标识 **取值范围** 32个字符组成的字符串 | | mock_switch | 否 | Boolean | **参数解释** mock开关 **取值范围** - true - false | | mock_url | 否 | String | **参数解释** mock地址 **取值范围** 不涉及 | 表11ValidateRule | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | dependent_info | 否 | Array of [ConditionInstance] objects | **参数解释** 依赖信息列表 **取值范围** 不涉及 | | enabled | 否 | Boolean | **参数解释** 是否启用的标识符 **取值范围** - true - false | | is_configDep | 否 | Boolean | **参数解释** 配置依赖的标识符 **取值范围** - true - false | | is_dependent | 否 | Boolean | **参数解释** 是否依赖的标识符 **取值范围** - true - false | | message | 否 | String | **参数解释** 消息 **取值范围** 不涉及 | | result | 否 | String | **参数解释** 结果 **取值范围** 不涉及 | | special_char | 否 | String | **参数解释** 特殊字符 **取值范围** 不涉及 | | special_char_valid | 否 | String | **参数解释** 特殊字符的有效性 **取值范围** 不涉及 | | x_example | 否 | String | **参数解释** 示例 **取值范围** 不涉及 | 表12ConditionInstance | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | conditionIndex | 否 | Integer | **参数解释** 条件索引，用于标识当前处理的是哪个条件 | | conditionMap | 否 | Map\\> | **参数解释** 条件映射，键为整数，值为字符串列表，用于存储各个条件的信息 **取值范围** 不涉及 | | depParamMap | 否 | Map\ | **参数解释** 依赖参数实例的映射 **取值范围** 不涉及 | | statementIndex | 否 | Integer | **参数解释** 声明索引，用于标识当前处理的是哪个声明 | 表13DepParamInstance | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | compareValue | 否 | String | **参数解释** 比较值 **取值范围** 不涉及 | | comparison | 否 | String | **参数解释** 比较符 **取值范围** 不涉及 | | condition | 否 | Boolean | **参数解释** 条件 | | inValidValues | 否 | Array of strings | **参数解释** 无效值列表 | | name | 否 | String | **参数解释** 名称 **取值范围** 不超过300个字符组成的字符串 | | nullInfo | 否 | String | **参数解释** 空值信息 **取值范围** 不涉及 | | relationMap | 否 | Map\ | **参数解释** 关系映射，key为整数，value为字符串 **取值范围** 不涉及 | | relationNum | 否 | Integer | **参数解释** 关系数量 **取值范围** 自然数 | | values | 否 | Array of strings | **参数解释** 值列表 **取值范围** 不涉及 | #### 响应参数 **状态码：200** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [CommonResponseErrorOfobject] object | **参数解释** 统一错误返回 **取值范围** 不涉及 | | reason | String | **参数解释** 接口调用失败原因 **取值范围** 不超过1000个字符组成的字符串 | | result | Object | **参数解释** 结果 **取值范围** 不涉及 | | status | String | **参数解释** '状态值，如success、error' **取值范围** - success，请求成功 - error，请求报错 | 表15CommonResponseErrorOfobject | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 接口调用失败错误码 **取值范围** 不超过256个字符组成的字符串 | | reason | String | **参数解释** 接口调用失败原因 **取值范围** 不超过1000个字符组成的字符串 | **状态码：401** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | **状态码：403** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | **状态码：404** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | **状态码：500** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | #### 请求示例 ``` { "extra_info" : { "document_link" : "", "summary" : "", "http_method" : "post", "mock" : { "mock_switch" : false, "mock_id" : "", "mock_url" : "" }, "param_dependent" : "", "http_url" : "www.huawei.com" }, "group_name" : "root", "name" : "test23333", "body_param_type" : "", "description" : "" } ``` #### 响应示例 **状态码：200** SUCCESS ``` { "status" : "success", "result" : { "id" : "bdf833f7b4484a81ae553f8eb8138017", "warningMsg" : null, "name" : "test23333", "source" : null, "method" : "post_hostUrl_www_huawei_com", "description" : "test23333", "nameView" : null, "tmssCaseNumber" : null, "region" : "{region}", "yamlName" : null, "create_time_string" : "2025-06-12 19:52:25 GMT+08:00", "update_time_string" : "2025-06-12 19:52:25 GMT+08:00", "create_time_stamp" : 1749729145000, "update_time_stamp" : 1749729145000, "create_user" : "CloudTest-0704", "create_time" : "2025-06-12T07:52:25+0800", "update_user" : "CloudTest-0704", "update_time" : "2025-06-12T07:52:25+0800", "param_type_and_dft_value" : [ { "type" : "String", "name" : "hostUrl", "required" : false, "disabled" : false, "description" : null, "mock" : null, "isChecked" : null, "is_big_field" : null, "value_type" : 0, "basic_value" : { "value" : "$${hostURL}", "value_range" : "" }, "enum_type" : null, "enum_type_selected" : null, "minLength" : null, "maxLength" : null, "minimum" : null, "maximum" : null, "format" : null, "pattern" : null, "xChoiceValue" : null, "maxItems" : null, "minItems" : null, "validate_rule" : null, "defaultValue" : null, "drop_down_value" : null, "in_type" : 1, "is_body_custom" : null, "custom_body" : null, "basic_value_list" : null, "object_value" : null, "object_value_list" : null, "is_contract_param" : null, "item" : null, "is_sensitive" : null }, { "type" : "String", "name" : "x-auth-token", "required" : false, "disabled" : false, "description" : null, "mock" : null, "isChecked" : null, "is_big_field" : null, "value_type" : 0, "basic_value" : { "value" : "******", "value_range" : "" }, "enum_type" : null, "enum_type_selected" : null, "minLength" : null, "maxLength" : null, "minimum" : null, "maximum" : null, "format" : null, "pattern" : null, "xChoiceValue" : null, "maxItems" : null, "minItems" : null, "validate_rule" : null, "defaultValue" : null, "drop_down_value" : null, "in_type" : 3, "is_body_custom" : null, "custom_body" : null, "basic_value_list" : null, "object_value" : null, "object_value_list" : null, "is_contract_param" : null, "item" : null, "is_sensitive" : true } ], "dft_custom_header" : null, "dft_check_point_list" : null, "dft_variable_list" : null, "keyword_variable_value" : null, "dft_retry_times" : null, "dft_retry_interval" : null, "return_type" : "[{\"returnCode\":200}]", "aw_type" : 1, "aw_ins_list" : null, "project_id" : "4d44481c21074c1e93c1d971e238b803", "public_aw_lib_id" : null, "special_type" : 90, "has_code" : 1, "aw_code" : "", "group_name" : "b8889baffe4440c8aea9a3988f0641d9", "protocol_type" : "http/https", "by_order" : 0, "aw_mark" : 1, "output_param_list" : null, "is_favorite" : null, "tmss_case_id" : null, "create_user_id" : null, "aw_description" : null, "origin_project" : null, "aw_uniqueid" : null, "aw_tags" : null, "aw_operationid" : null, "interface_label" : null, "import_package" : null, "public_aw_lib" : null, "root_id" : null, "custom_aw_libs" : null, "delete_time" : null, "delete_user" : null, "extra_info" : { "summary" : "", "mock" : { "mock_url" : "", "mock_id" : "", "mock_switch" : false }, "http_method" : "post", "http_url" : "http://{hostUrl}www.huawei.com", "document_link" : "", "param_dependent" : "" } }, "reason" : null, "error" : null } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | SUCCESS | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | | 500 | ERROR | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。