- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 测试计划服务(CodeArts TestPlan)使用流程
- 开通CodeArts TestPlan服务
- 访问CodeArts TestPlan服务首页
- 配置CodeArts TestPlan测试计划
- 配置CodeArts TestPlan测试版本
-
配置CodeArts TestPlan测试用例
- CodeArts TestPlan生成测试用例方式介绍
- 通过思维导图创建测试用例
- 创建手工测试用例
-
创建接口自动化测试用例
- CodeArts TestPlan接口自动化用例使用流程
- 创建CodeArts TestPlan接口自动化测试用例模板
- 使用自定义URL请求添加CodeArts TestPlan接口脚本
- 使用Postman快速添加CodeArts TestPlan接口脚本
- 使用cURL快速添加CodeArts TestPlan接口脚本
- 使用关键字库快速添加CodeArts TestPlan接口脚本
- 添加CodeArts TestPlan接口脚本的逻辑控制步骤
- 设置CodeArts TestPlan接口脚本的测试用例参数
- 设置CodeArts TestPlan接口脚本的环境参数
- 导入CodeArts TestPlan接口自动化用例测试数据集
-
接口自动化用例内置函数说明
- 在CodeArts TestPlan中调用二元加法运算函数
- 在CodeArts TestPlan中调用二元减法运算函数
- 在CodeArts TestPlan中调用二元乘法运算函数
- 在CodeArts TestPlan中调用二元除法运算函数
- 在CodeArts TestPlan中调用获取当前时间戳函数
- 在CodeArts TestPlan中调用获取指定时间戳函数
- 在CodeArts TestPlan中调用日期转时间戳函数
- 在CodeArts TestPlan中调用时间戳转日期函数
- 在CodeArts TestPlan中调用时间戳加减运算函数
- 在CodeArts TestPlan中调用生成Base64编码函数
- 在CodeArts TestPlan中调用生成SHA512编码函数
- 在CodeArts TestPlan中调用生成SHA256编码函数
- 在CodeArts TestPlan中调用生成MD5哈希值函数
- 在CodeArts TestPlan中调用生成指定范围随机数函数
- 在CodeArts TestPlan中调用生成指定长度随机字符串函数
- 在CodeArts TestPlan中调用指定范围随机生成小数函数
- 在CodeArts TestPlan中调用生成UUID函数
- 在CodeArts TestPlan中调用倒序索引提取数组函数
- 在CodeArts TestPlan中调用倒序索引提取数组元素的值函数
- 在CodeArts TestPlan中调用大写转小写函数
- 在CodeArts TestPlan中调用小写转大写函数
- 在CodeArts TestPlan中调用字符串拼接函数
- 在CodeArts TestPlan中调用多个参数字符串拼接函数
- 在CodeArts TestPlan中调用字符串切割函数
- 在CodeArts TestPlan中调用获取字符串长度函数
-
接口自动化用例系统关键字说明
- 系统关键字概述与一览表
- 在CodeArts TestPlan接口脚本中调用GetIAMToken关键字
- 在CodeArts TestPlan接口脚本中调用OAuth2ForOneAccess关键字
- 在CodeArts TestPlan接口脚本中调用MySQLQuery关键字
- 在CodeArts TestPlan接口脚本中调用MySQLUpdate关键字
- 在CodeArts TestPlan接口脚本中调用MySQLInsert关键字
- 在CodeArts TestPlan接口脚本中调用MySQLDelete关键字
- 在CodeArts TestPlan接口脚本中调用OpenGaussQuery关键字
- 在CodeArts TestPlan接口脚本中调用OpenGaussUpdate关键字
- 在CodeArts TestPlan接口脚本中调用OpenGaussInsert关键字
- 在CodeArts TestPlan接口脚本中调用OpenGaussDelete关键字
- 在CodeArts TestPlan接口脚本中调用PostgreSQLQuery关键字
- 在CodeArts TestPlan接口脚本中调用PostgreSQLUpdate关键字
- 在CodeArts TestPlan接口脚本中调用PostgreSQLInsert关键字
- 在CodeArts TestPlan接口脚本中调用PostgreSQLDelete关键字
- 在CodeArts TestPlan接口脚本中调用MongoDBQuery关键字
- 在CodeArts TestPlan接口脚本中调用MongoDBInsert关键字
- 在CodeArts TestPlan接口脚本中调用MongoDBUpdate关键字
- 在CodeArts TestPlan接口脚本中调用MongoDBDelete关键字
- 在CodeArts TestPlan接口脚本中调用RedisGet关键字
- 在CodeArts TestPlan接口脚本中调用RedisSet关键字
- 在CodeArts TestPlan接口脚本中调用OBSWrite关键字
- 在CodeArts TestPlan接口脚本中调用OBSDelete关键字
- 在CodeArts TestPlan接口脚本中调用OBSQuery关键字
- 在CodeArts TestPlan接口脚本中调用KafkaProducer关键字
- 在CodeArts TestPlan接口脚本中调用KafkaConsumer关键字
- 在CodeArts TestPlan接口脚本中调用TCP关键字
- 在CodeArts TestPlan接口脚本中调用UDP关键字
- 在CodeArts TestPlan接口脚本中调用WSConnect关键字
- 在CodeArts TestPlan接口脚本中调用WSRequest关键字
- 在CodeArts TestPlan接口脚本中调用WSWriteOnly关键字
- 在CodeArts TestPlan接口脚本中调用WSReadOnly关键字
- 在CodeArts TestPlan接口脚本中调用WSDisConnect关键字
- 在CodeArts TestPlan接口脚本中调用MQTTConnect关键字
- 在CodeArts TestPlan接口脚本中调用MQTTDisconnect关键字
- 在CodeArts TestPlan接口脚本中调用MQTTPublish关键字
- 在CodeArts TestPlan接口脚本中调用MQTTSubscribe关键字
- 在CodeArts TestPlan接口脚本中调用DubboClient关键字
- 创建CodeArts TestPlan性能自动化测试用例
- 创建CodeArts TestPlan自定义自动化测试用例
- 通过CodeArts TestPlan测试资产中心模板创建测试用例
- 执行CodeArts TestPlan测试用例
- 管理CodeArts TestPlan测试用例
- 创建与执行CodeArts TestPlan测试套件
- 查看与评估CodeArts TestPlan测试质量
- 在CodeArts TestPlan中使用在线拨测
- 配置CodeArts TestPlan全局配置项
- IPD测试流程与实践
- 测试用例编写规范
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 测试报表管理
- 接口测试套管理
- 环境参数分组管理
- 项目配置
- 测试计划管理
- 自定义测试服务测试套件管理
-
自定义测试服务用例管理
- 批量执行测试用例
- 批量更新测试用例结果
- 通过用例编号获取测试用例详情
- 创建自定义测试服务类型用例
- 批量删除自定义测试服务类型用例
- 获取测试用例详情
- 更新自定义测试服务类型用例
- 查询用例修改历史记录
- 查询用例列表
- 获取资源池列表
- 查询附件列表
- 获取测试报告的模板设置
- 获取租户订单已用资源信息
- 获取异步进度
- 获取项目测试用例自定义字段列表
- 查询限时免费用户免责声明记录
- 获取测试类型列表
- 查询用例详情
- 生成资源URI
- 根据domainId获取加密的testbirdkey
- 查询用户免责声明
- 查询项目字段配置
- 获取目录
- 获取分支列表
- 新增分支
- 获取租户订单信息
- 获取责任人是自己的测试用例
- 查询用例列表
- 版本测试用例变更统计(只统计分支,不统计基线)
- 向迭代中添加资源
- 从迭代中批量移除用例
- 保存单个自定义报表
- 批量删除用例
- 在分支或者测试计划下修改用例
- 在分支或者测试计划下创建用例
- 批量更新用例属性
- 查询用例评论
- 新增用例评论
- 修改用例评论
- 删除用例评论
- 查询测试用例关联的需求或缺陷是否存在于当前测试计划中
- 根据用例查询评审记录
- 下载导出用例文件
- 统计特性用例数量
- 设置用例结果
- 查询自定义过滤器列表
- 新增自定义过滤器
- 查询用例、测试套版本号
- 查询用户自定义配置
- 导出测试用例
- 获取租户订单及免费额度信息
- 查询用例结果
- 获取资源修改历史记录
- 移除用例前判断是否关联需求
- 查询迭代计划下用例URI和迭代下需求关联用例URI信息
- 查询标签
- 查询迭代下的缺陷信息
- 查询用户自定义列展示及顺序配置
- 清空需求动态
- 自定义测试服务接入管理
- 测试服务关联关系
- 拨测任务配置管理
- 拨测告警信息管理
- 拨测仪表盘信息管理
- 拨测套餐状态查询
- 接口测试套餐信息查询
- 测试设计接口管理
- 接口测试管理
- 用例关联关系管理
- 应用示例
- 附录
-
常见问题
- 测试套件中没有用例
- 用户没有操作权限
- 接口自动化测试套件正在执行或正在排队
- 测试套件不存在
- 测试套件中的版本号信息是在什么地方创建维护的?
- 手工测试用例中的附件无法下载
- 测试计划中没有用例
- 将缺陷与测试用例的关系解除后,测试质量看板缺陷没有归零
- 思维导图生成用例后,测试步骤、预期结果存在空的序号
- 新建及更新测试计划时无法添加Task等类型的工作项
- 测试用例无法关联到Task等类型工作项
- 测试报告中的“用例完成率”无法到达100%
- 为何在用例库与测试计划中,同一个测试用例的状态显示不一致?
- 接口自动化用例中前后步骤如何传递变量
- 接口自动化用例中测试步骤检查点如何设置
- 账户已经关闭(免费额度已使用完)
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
构造请求
本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
请求URI
尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
请求URI由四部分构成:{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}。
各参数含义如下:
参数 |
说明 |
---|---|
URI-scheme |
表示用于传输请求的协议,当前所有API均采用HTTPS协议。 |
Endpoint |
指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。 例如,IAM服务在华北-北京一区域的Endpoint为iam.cn-north-1.myhuaweicloud.com。 |
resource-path |
资源路径,即API访问路径,从具体API的URI模块获取。例如,获取用户Token接口的resource-path为/v3/auth/tokens。 |
query-string |
查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个?,形式为参数名=参数取值。例如,limit=10表示查询不超过10条数据。 |
例如:如果需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示:
https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。详情如下:
请求方法 |
说明 |
---|---|
GET |
请求服务器返回指定资源。 |
PUT |
请求服务器更新指定资源。 |
POST |
请求服务器新增资源或执行特殊操作。 |
DELETE |
请求服务器删除指定资源,如删除对象等。 |
HEAD |
请求服务器资源头部。 |
在获取用户Token的URI部分,若请求方法为POST,则其请求为:
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
请求消息头
附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如,定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
如下公共消息头需要添加到请求中:
名称 |
描述 |
是否必选 |
备注 |
---|---|---|---|
Content-Type |
消息体的类型(格式) |
是 |
默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 |
X-Auth-Token |
用户Token |
否 |
用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 |
X-Project-ID |
子项目ID |
否 |
在多项目场景中使用 |
X-Domain-ID |
账号ID |
- |
- |
公有云API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。
AK/SK认证的详细说明请参考AK/SK认证。
对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下:
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxx为project的ID,获取方法请参见获取项目ID。
scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { id": "xxxxxxxx" } } } }
到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。