查询免费测试时间以及是否开通 - ShowFreeTestTime

功能介绍

根据项目唯一标识和当前用户查询免费测试时间以及是否开通

调用方法

请参见如何调用API。

URI

GET /v2/queryFreeTestTime/{testServiceId}

表1 路径参数
参数	是否必选	参数类型	描述
testServiceId	是	String	参数解释项目唯一标识约束限制不涉及取值范围 32个字符组成的字符串默认取值不涉及获取方法进入项目，地址栏获取testServiceId

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
error	CommonResponseErrorOfobject object	参数解释统一错误返回取值范围不涉及
result	QueryIsFreeResponse object	参数解释结果取值范围不涉及
status	String	参数解释请求结果状态取值范围 success, 查询计费信息成功 error, 查询计费信息失败 3-128个字符组成的字符串

表4 CommonResponseErrorOfobject
参数	参数类型	描述
code	String	参数解释接口调用失败错误码取值范围不超过256个字符组成的字符串
reason	String	参数解释接口调用失败原因取值范围不超过1000个字符组成的字符串

表5 QueryIsFreeResponse
参数	参数类型	描述
domainStatus	Integer	租户状态，1normal，2freeze，3close
freeQuota	Integer	是否有免费时长,1有，2无
isWhiteDomain	Integer	是否是白名单用户,0不是，1是
openservice_time	String	开通服务时间
package_type	String	包周期计费类型
report_usetime	String	已用测试时长(用于统计上报时)
usetest_time	String	已用测试时长
warnMessage	String	警告信息
needPopup	Boolean	判断包周期计费是否需要弹出框提醒
regionId	String	区域唯一标识
domainId	String	租户唯一标识

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：403

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：404

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：500

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

请求示例

get https://{endpoint}/v2/queryFreeTestTime/5a20b8323f3548008bd6e5669567538f

响应示例

状态码：200

{
  "status" : "success",
  "result" : {
    "freeQuota" : 2,
    "domainStatus" : 1,
    "isWhiteDomain" : null,
    "domainId" : "7b90e408636344328e44bf70bbae8351",
    "regionId" : "{region}",
    "needPopup" : false,
    "warnMessage" : null,
    "openservice_time" : "2023-10-28 16:56:05",
    "package_type" : "codearts.testplan.china.pro",
    "report_usetime" : 3087.975148,
    "usetest_time" : 604.9151189999999
  },
  "error" : null
}