文档首页/ 智能数据湖 AI DataLake/ API参考/ 用户协议管理/ 查询用户是否签署协议 - ShowV2Agreement
更新时间：2026-08-12 GMT+08:00
查看PDF
分享

查询用户是否签署协议 - ShowV2Agreement

功能介绍

查询用户是否签署协议。此接口为同步接口，无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

GET /v2/agreement

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token。

约束限制：不涉及。

取值范围：长度不超过65534个字符。

默认取值：不涉及。

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

agreements

Array of TenantV2Agreement objects

参数解释：租户协议列表。

total

Integer

参数解释：租户注册的协议总数。

取值范围：0~1000。
表3 TenantV2Agreement

参数

参数类型

描述

agreement_name

String

参数解释：协议名称。

取值范围：长度为1~64的英文字母、数字、下划线和中划线的组合。

version

String

参数解释：协议版本号。

取值范围：长度为1~32的英文字母、数字的组合。

create_time

String

参数解释：资源创建时间。

取值范围：ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSZ，UTC时间。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：408

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

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

取值范围：长度为0~4096个字符。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

请求示例

用户通过该接口查询已签署的租户协议。

GET /v2/agreement

响应示例

状态码：200

请求成功。

{
  "agreements" : [ {
    "agreement_name" : "test_name",
    "version" : "v1",
    "create_time" : "2025-01-10T03:37:12.000+00:00"
  } ],
  "total" : 1
}

状态码：400

请求参数错误。

{
  "error_code" : "AIDataLake.00010151",
  "error_msg" : "Parameter value is invalid.",
  "solution_msg" : "Please input valid parameter value."
}

状态码：401

未授权。

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
  "solution_msg" : "Check whether the IAM authentication information is correct."
}

状态码：403

禁止访问。

{
  "error_code" : "AIDataLake.00010150",
  "error_msg" : "The operation is not allowed.",
  "solution_msg" : "Check whether the operation is allowed in the current status."
}

状态码：404

资源未找到。

{
  "error_code" : "AIDataLake.00010009",
  "error_msg" : "No resources found.",
  "solution_msg" : "Enter correct resource and project IDs."
}

状态码：408

请求超时。

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

内部服务器错误。

{
  "error_code" : "AIDataLake.00011001",
  "error_msg" : "Internal error.",
  "solution_msg" : "Contact technical support or try again later."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

404

资源未找到。

408

请求超时。

500

内部服务器错误。
父主题： 用户协议管理

相关文档