更新时间:2023-12-26 GMT+08:00
分享

新测试类型服务注册

功能介绍

通过接口CreateService注册成为自定义服务。注册完成后界面将会出现此自定义测试类型。自定义服务类型不能超过5个。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/services

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表2 请求Body参数

参数

是否必选

参数类型

描述

server_host

String

server_host是由用户提供的域名。 我们会通过此域名进行接口调用,请以https/http开头,长度小于等于128位字符。 TestHub将会通过此域名下的接口,保证服务数据与用户系统数据的一致性。

service_name

String

测试类型名称,用于界面显示,不能使用当前保留名,长度小于等于128。

响应参数

状态码: 201

表3 响应Body参数

参数

参数类型

描述

service_id

Integer

接口调用成功返回的服务id

service_name

String

接口调用成功返回的服务名

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

注册新测试类型服务

post https://{endpoint}/v1/services

{
  "server_host" : "https://xxx.xxx.xxx",
  "service_name" : "某个新服务名称"
}

响应示例

状态码: 201

Created

{
  "service_id" : 13,
  "service_name" : "某个新服务名称"
}

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品