更新时间:2024-11-19 GMT+08:00
分享

根据id获取单个basicAW信息

功能介绍

根据id获取单个basicAW信息

URI

GET /v3/{project_id}/basic-aw/{aw_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,固定长度32位字符(字母和数字)。

aw_id

String

AW ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

code

String

错误码

error

CommonResponseErrorOfAPITest object

统一错误返回

reason

String

失败原因

result

BasicAwRes object

结果

status

String

状态

表4 CommonResponseErrorOfAPITest

参数

参数类型

描述

code

String

错误码

reason

String

错误原因

表5 BasicAwRes

参数

参数类型

描述

aw_code

String

关键字代码, hascode字段为1是有效

aw_description

String

模板描述

aw_mark

Integer

关键字标记

aw_operationid

String

关键字操作编号

aw_tags

String

关键字tags

aw_type

Integer

关键字类型

aw_uniqueid

String

关键字来源编号

by_order

Integer

关键字顺序

create_time

String

创建时间

create_time_stamp

Long

创建时间戳

create_time_string

String

创建时间戳

create_user

String

创建人

create_user_id

String

创建人ID

delete_time

String

更新时间

delete_user

String

删除人

description

String

描述

dft_check_point_list

Array of objects

默认检查点列表

dft_custom_header

Array of objects

默认请求头参数对象

dft_retry_interval

String

重试间隔时间 (ms) 为空表示不等待

dft_retry_times

String

重试次数

dft_variable_list

Array of objects

默认变量信息

extra_info

Object

补充信息

group_name

String

分组名

has_code

Integer

是否存在代码

id

String

编号

import_package

Array of strings

导入的包名

interface_label

String

接口的x-extend字段说明

is_favorite

Integer

是否收藏

method

String

方法名

name

String

关键字名

nameView

String

在页面上显示的名字

origin_project

String

源工程信息

param_type_and_dft_value

Array of objects

参数类型和参数默认值

project_id

String

工程编号

protocol_type

String

协议类型

public_aw_lib

Object

公共关键字信息

public_aw_lib_id

String

公共关键字id

region

String

region信息

return_type

String

返回值类型

root_id

String

根节点编号

source

String

关键字依赖的类源

special_type

Integer

特殊关键字类型

tmssCaseNumber

String

关键字编号(来自测试管理服务)

tmss_case_id

String

测试用例id

update_time

String

更新时间

update_time_stamp

Long

更新时间戳

update_time_string

String

更新时间戳(字符串格式)

update_user

String

更新人

warningMsg

String

警告信息

yamlName

String

yaml名称

请求示例

get https://{endpoint}/v3/17dbf1f26078431fa9f4e09525befb2a/basic-aw/82042499e81f4f3796fa833553f5f25b

响应示例

状态码: 200

SUCCESS

{
  "status" : "success",
  "result" : {
    "id" : "82042499e81f4f3796fa833553f5f25b",
    "warningMsg" : null,
    "name" : "getGroupConfigForPermissionUsingGET",
    "source" : null,
    "method" : "getGroupConfigForPermissionUsingGET",
    "description" : "查询群组配置是否有默认允许权限",
    "nameView" : null,
    "tmssCaseNumber" : null,
    "region" : "cn-north-208",
    "yamlName" : null,
    "create_time_string" : "2023-09-28 15:43:51 GMT+08:00",
    "update_time_string" : "2023-09-28 15:43:51 GMT+08:00",
    "create_time_stamp" : 1695887031000,
    "update_time_stamp" : 1695887031000,
    "create_user" : "xxxxxxxxxx",
    "create_time" : "2023-09-28T03:43:51+0800",
    "update_user" : "xxxxxxxxxx",
    "update_time" : "2023-09-28T03:43:51+0800",
    "param_type_and_dft_value" : [ {
      "type" : "String",
      "name" : "hostURL",
      "required" : true,
      "disabled" : false,
      "description" : null,
      "mock" : null,
      "isChecked" : null,
      "is_big_field" : null,
      "value_type" : 0,
      "basic_value" : {
        "value" : "xxxx.cd-cloud-test.xxxx.tools.huawei.com",
        "value_range" : null
      },
      "enum_type" : null,
      "enum_type_selected" : null,
      "minLength" : -1001,
      "maxLength" : -1001,
      "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" : null,
      "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" : "group_id",
      "required" : true,
      "disabled" : false,
      "description" : "项目id",
      "mock" : null,
      "isChecked" : null,
      "is_big_field" : null,
      "value_type" : 0,
      "basic_value" : {
        "value" : null,
        "value_range" : null
      },
      "enum_type" : null,
      "enum_type_selected" : null,
      "minLength" : -1001,
      "maxLength" : -1001,
      "minimum" : -1001,
      "maximum" : -1001,
      "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
    } ],
    "dft_custom_header" : [ {
      "type" : "String",
      "name" : "Accept",
      "required" : false,
      "disabled" : false,
      "description" : null,
      "mock" : null,
      "isChecked" : null,
      "is_big_field" : null,
      "value_type" : 0,
      "basic_value" : {
        "value" : "application/json;charset=utf-8",
        "value_range" : null
      },
      "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" : null
    } ],
    "dft_check_point_list" : null,
    "dft_variable_list" : null,
    "dft_retry_times" : null,
    "dft_retry_interval" : null,
    "return_type" : "[{\"returnCode\":200,\"type\":\"basic\",\"body\":\"未被定义为引用\"},{\"returnCode\":401},{\"returnCode\":403},{\"returnCode\":404}]",
    "aw_type" : 1,
    "project_id" : "17dbf1f26078431fa9f4e09525befb2a",
    "public_aw_lib_id" : null,
    "special_type" : 0,
    "has_code" : 1,
    "aw_code" : "",
    "group_name" : "4281c04b40d44d1d8ce7bc34c503527e",
    "protocol_type" : "http/https",
    "by_order" : 0,
    "aw_mark" : 1,
    "is_favorite" : null,
    "tmss_case_id" : null,
    "create_user_id" : "efdb403066474ab08836b9eeaaa23bca",
    "aw_description" : null,
    "origin_project" : null,
    "aw_uniqueid" : "APITEST ATSERVICE API >> at-config-controller >> getGroupConfigForPermissionUsingGET",
    "aw_tags" : "at-config-controller",
    "aw_operationid" : "getGroupConfigForPermissionUsingGET",
    "interface_label" : null,
    "import_package" : null,
    "public_aw_lib" : null,
    "root_id" : null,
    "delete_time" : null,
    "delete_user" : null,
    "extra_info" : {
      "http_url" : "https://{hostURL}/xxxx/v1/xxxx/{group_id}",
      "http_method" : "get"
    }
  },
  "reason" : null,
  "error" : null,
  "code" : null
}

状态码

状态码

描述

200

SUCCESS

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档