文档首页/ 数智融合计算服务/ API参考/ API/ fabric-admin/ 用户协议管理/ 注册租户协议
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

注册租户协议

功能介绍

注册租户协议。

调试

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

URI

POST https://localhost.com/v1/agreement

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

  • 参数解释：租户Token。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表2 请求Body参数

参数

是否必选

参数类型

描述

agreements

否

Array of TenantAgreement objects

租户协议列表。
表3 TenantAgreement

参数

是否必选

参数类型

描述

agreement_name

否

String

  • 参数解释：协议名称。

  • 约束限制：只能包含字母、数字、下划线和中划线，且长度为1-64个字符。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

agreement_version

否

String

  • 参数解释：协议版本号。

  • 约束限制：只能包含字母和数字，且长度为1-32个字符。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

-

AnyType

空响应。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 408

表8 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

请求示例

无

响应示例

无

状态码

状态码

描述

200

空响应。

400

Bad request error。

401

Unauthorized error。

403

Forbidden error。

404

Not found error。

408

Request timeout error。

500

Internal error。

错误码

请参见错误码。

父主题： 用户协议管理

相关文档