网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

新增用户自定义URL关键字

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

功能介绍

新增用户自定义URL关键字

URI

POST /v1/{project_id}/basic-aw

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

body_param_type

String

body请求体的类型:text(包含JSON,参数内部区分)、form

description

String

描述

dft_check_point_list

Array of CheckPoint objects

默认检查点List

dft_custom_header

Array of AwParam objects

默认请求头参数对象

dft_variable_list

Array of AwVariable objects

定义的变量信息

extra_info

ExtraInfo object

补充信息

group_name

String

组名

name

String

名称

param_type_and_dft_value

Array of AwParam objects

参数类型和参数默认值对应List

表4 CheckPoint

参数

是否必选

参数类型

描述

comparison

String

运算符

description

String

描述信息

function_arg

String

响应提取时要使用什么方法处理参数

function_type

String

响应提取时要使用什么方法处理参数

property

String

属性名称

value

String

表5 ExtraInfo

参数

是否必选

参数类型

描述

childImportPackage

Array of strings

子级导入的包

document_link

String

文档链接

http_method

String

http请求方法

http_url

String

HTTP请求的URL

importPackage

Array of strings

导入的包

mock

MockInfo object

awInstance中的mock信息

outputParam

Array of AwVariable objects

输出参数

param_dependent

String

参数依赖

summary

String

摘要

表6 AwVariable

参数

是否必选

参数类型

描述

by_order

Integer

节点顺序

currentPermission

String

当前人员权限

description

String

参数描述

dynamicParam

String

动态参数名称

dynamicParamFlag

Boolean

动态参数标志,默认为false:true代表动态参数;false代表非动态参数

functionParams

String

变量参数([]:空参、[a]:一参,[a,b]:两参)

function_arg

String

响应提取时要使用什么方法处理参数

function_type

String

响应提取时要使用什么方法处理参数

isSensitiveInfo

Boolean

是否是敏感字段

isSensitiveModified

Boolean

敏感字段是否被修改,不敏感字段不关注此值

is_out_put

Boolean

是否是组合aw的输出参数,只有组合aw下awInstance的aw变量有该字段

name

String

参数名称

node_id

String

节点id

node_type

Integer

0/null-变量节点;1-目录节点

oldName

String

旧名称

parent_node_id

String

父节点id

property

String

属性

regex

String

内置函数枚举

sensitiveInfoSetterTime

String

敏感参数设置时间

sensitiveInfoSetterUser

String

敏感参数设置者名称

type

String

类型

variableType

Integer

变量类型(0:text,10-16:7个内置函数)

表7 AwParam

参数

是否必选

参数类型

描述

basic_value

AwParamBasicValue object

aw参数基本类型取值类

basic_value_list

Array of AwParamBasicValue objects

valueType为1时该值有效

custom_body

String

自定义requestBody内容,inType为2且isBodyCustom为1时有效

defaultValue

String

默认值

description

String

aw参数描述

disabled

Boolean

是否禁用 只有非必需参数才能被禁用

drop_down_value

String

用于存储下拉菜单的值

enum_type

String

枚举类型

enum_type_selected

String

当前选中的枚举类型

format

String

num和String有效

in_type

Integer

rest接口输入参数类型 0-query 1-path 2-body 3-header 4-formdata 5-config

isChecked

Boolean

是否是被选中参数

is_big_field

Boolean

是否是大字段参数

is_body_custom

Integer

requestBody是否自定义,inType为2时有效。0-非自定义,用原有逻辑;1-自定义body,requestBody直接使用字段customBody

is_contract_param

Integer

是否是契约AW 0-否;1-yes

is_sensitive

Boolean

是否敏感参数,0 是, 1 不是

item

ItemParam object

item param

maxItems

Integer

Array类型最大元素数

maxLength

Long

String类型最大长度

maximum

Object

Number类型最大值

minItems

Integer

Array类型最小元素数

minLength

Long

String类型最小长度

minimum

Object

Number类型最小值

mock

MockInfo object

awInstance中的mock信息

name

String

参数名

object_value

Array of AwParam objects

valueType为2时该值有效。valueType为3时,该值用来表示数组中单个结构体

object_value_list

Array<Array<AwParam>>

valueType为3时该值有效

pattern

String

num和String有效

required

Boolean

是否必需参数

type

String

参数类型

validate_rule

ValidateRule object

validate rule

value_type

Integer

参数值类型

xChoiceValue

String

choice选择关系

表8 AwParamBasicValue

参数

是否必选

参数类型

描述

value

String

参数默认值,用例有效

value_range

String

参数值范围,逻辑用例有效

表9 ItemParam

参数

是否必选

参数类型

描述

basic_value

AwParamBasicValue object

aw参数基本类型取值类

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

参数类型

validate_rule

ValidateRule object

validate rule

value_type

Integer

参数值类型

xChoiceValue

String

choice选择关系

表10 MockInfo

参数

是否必选

参数类型

描述

mock_id

String

mock id

mock_switch

Boolean

mock开关

mock_url

String

mock url

表11 ValidateRule

参数

是否必选

参数类型

描述

dependent_info

Array of ConditionInstance objects

依赖信息列表

enabled

Boolean

是否启用的标识符

is_configDep

Boolean

配置依赖的标识符

is_dependent

Boolean

是否依赖的标识符

message

String

消息

result

String

结果

special_char

String

特殊字符

special_char_valid

String

特殊字符的有效性

x_example

String

示例

表12 ConditionInstance

参数

是否必选

参数类型

描述

conditionIndex

Integer

条件索引,用于标识当前处理的是哪个条件

conditionMap

Map<String,Array<String>>

条件映射,键为整数,值为字符串列表,用于存储各个条件的信息

depParamMap

Map<String,DepParamInstance>

依赖参数实例的映射

statementIndex

Integer

声明索引,用于标识当前处理的是哪个声明

表13 DepParamInstance

参数

是否必选

参数类型

描述

compareValue

String

比较值

comparison

String

比较

condition

Boolean

条件

inValidValues

Array of strings

无效值列表

name

String

名称

nullInfo

String

空值信息

relationMap

Map<String,String>

关系映射,key为整数,value为字符串

relationNum

Integer

关系数量

values

Array of strings

值列表

响应参数

状态码: 200

表14 响应Body参数

参数

参数类型

描述

code

String

错误码

error

CommonResponseErrorObject object

统一错误返回

reason

String

失败原因

result

Object

结果

status

String

状态

表15 CommonResponseErrorObject

参数

参数类型

描述

code

String

错误码

reason

String

错误原因

请求示例

post https://{endpoint}/v1/09645c1f3f954a8d9ab29174857cffc5/basic-aw

{
  "name" : "baidu2",
  "group_name" : "dfaba6a51f024c1f95229c1059ca34e0",
  "description" : "自定义URL请求",
  "extra_info" : {
    "http_url" : "http://www.baidu.com",
    "http_method" : "get"
  },
  "param_type_and_dft_value" : [ ],
  "dft_check_point_list" : [ ],
  "dft_variable_list" : [ ]
}

响应示例

状态码: 200

OK

{
  "status" : "success",
  "result" : {
    "id" : "37df588351464f45944580b288556d37",
    "warningMsg" : null,
    "name" : "baidu1",
    "source" : null,
    "method" : "getwww_baidu_com",
    "description" : "自定义URL请求",
    "nameView" : null,
    "tmssCaseNumber" : null,
    "region" : "cn-north-7",
    "yamlName" : null,
    "create_time_string" : "2024-06-21 15:46:18 GMT+08:00",
    "update_time_string" : "2024-06-21 15:46:18 GMT+08:00",
    "create_time_stamp" : 1718955978000,
    "update_time_stamp" : 1718955978000,
    "create_user" : "devcloud_devcloud_s00314720_01",
    "create_time" : "2024-06-21T03:46:18+0800",
    "update_user" : "devcloud_devcloud_s00314720_01",
    "update_time" : "2024-06-21T03:46:18+0800",
    "param_type_and_dft_value" : [ ],
    "dft_custom_header" : null,
    "dft_check_point_list" : [ ],
    "dft_variable_list" : [ ],
    "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" : "09645c1f3f954a8d9ab29174857cffc5",
    "public_aw_lib_id" : null,
    "special_type" : 90,
    "has_code" : 1,
    "aw_code" : "",
    "group_name" : "dfaba6a51f024c1f95229c1059ca34e0",
    "protocol_type" : "http/https",
    "by_order" : 1,
    "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" : {
      "http_method" : "get",
      "http_url" : "http://www.baidu.com"
    }
  },
  "reason" : null,
  "error" : null,
  "code" : null
}

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容