根据projectuuid,查询domain信息,包括老套餐信息,试用期信息,租户prefix为空的租户(支持用户账号和机机账号)
功能介绍
根据projectuuid,查询domain信息,包括老套餐信息,试用期信息,租户prefix为空的租户(支持用户账号和机机账号)
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/domain/detail-info
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
order_query_type |
否 |
String |
查询domain的方式,默认不传查询老套餐domain。codearts.testplan.china:查询单飞套餐。mix:合并查询单飞套餐和老套餐domain,根据套餐最新更新时间选择返回套餐。如单飞套餐是最新购买的,则会返回单飞套餐 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
success|error |
result |
请求返回的数据 |
|
error |
ApiError object |
错误信息 |
request_id |
String |
由接口调用方传入,建议使用UUID保证请求的唯一性。 |
server_address |
String |
本次请求的受理的服务地址 |
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
value |
DomainDetailInfoVo object |
请求返回的数据 |
reason |
String |
业务失败的提示内容 |
page_size |
Integer |
分页大小 |
page_no |
Integer |
分页编码 |
has_more |
Boolean |
是否有更多 |
参数 |
参数类型 |
描述 |
---|---|---|
region |
String |
逻辑Region |
status |
String |
订单状态 |
packageType |
String |
订单类型(基础版、专业版、铂金版) |
prefix |
String |
套餐类型前缀 |
expired |
Boolean |
是否试用期过期 |
domain_id |
String |
租户id |
package_number |
Integer |
订单限定的人头数 |
high_package_type |
String |
使用过的最高套餐 |
trial_start_time_stamp |
Long |
试用开通时间(时间戳格式) |
trial_period |
Integer |
试用天数 |
update_time_stamp |
Long |
更新时间戳 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
get https://{endpoint}/v4/projects/2e8b14eb90d54b6c9bc4c0b5cde1f449/domain/detail-info
响应示例
状态码:200
OK
{ "status" : "string", "result" : { "total" : 0, "value" : { "region" : "cn-north-4", "status" : "init/close/normal/freeze", "packageType" : "basic/professional/platinum", "prefix" : "套餐类型前缀", "expired" : false, "domain_id" : "ioufg854n20mds", "package_number" : 5, "high_package_type" : "使用过的最高套餐", "trial_start_time_stamp" : 1660617231016, "trial_period" : 30, "update_time_stamp" : 1660617231016 }, "reason" : "string", "page_size" : 0, "page_no" : 0, "has_more" : true }, "error" : { }, "request_id" : "string", "server_address" : "string" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。