文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 自定义测试服务用例管理/ 获取租户订单及免费额度信息
更新时间：2024-09-12 GMT+08:00
查看PDF
分享

获取租户订单及免费额度信息

功能介绍

获取租户订单及免费额度信息

URI

GET /v4/domain/access-info

表1 Query参数

参数

是否必选

参数类型

描述

project_uuid

是

String

项目ID

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueAccessInfoVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址
表3 ResultValueAccessInfoVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

AccessInfoVo object

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表4 AccessInfoVo

参数

参数类型

描述

message

String

租户服务开通提示信息

domain_order_status

String

租户订单状态

has_free_quota

Boolean

是否有免费配额
表5 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

获取租户订单及免费额度信息

get https://{endpoint}/v4/domain/access-info?project_uuid=84b218bb1b504019bbeb64b8dc745a94

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "domain_order_status" : "normal",
      "has_free_quota" : false
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档