查询用户是否注册协议
功能介绍
查询用户是否注册协议。此接口为同步接口，无配套使用接口和特殊场景。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/agreement
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。 约束限制：不涉及。 取值范围：长度不超过65534个字符。 默认取值：不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agreements |
Array of TenantAgreement objects |
参数解释：租户协议列表。 约束限制：不涉及。 取值范围：[0,1000]。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agreement_name |
String |
参数解释：协议名称。 约束限制：不涉及。 取值范围：长度为[1,64]的字母、数字、下划(_)和中划线(-)的组合。 默认取值：不涉及。 |
|
agreement_version |
String |
参数解释：协议版本号。 约束限制：不涉及。 取值范围：长度为[1,32]的字母、数字的组合。 默认取值：不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
状态码：408
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：错误码。 约束限制：不涉及。 取值范围：长度为[8,36]个字符。 默认取值：不涉及。 |
|
error_msg |
String |
参数解释：错误描述。 约束限制：不涉及。 取值范围：长度为[2,512]个字符。 默认取值：不涉及。 |
|
solution_msg |
String |
参数解释：解决方案描述。 约束限制：不涉及。 取值范围：长度为[0,4096]个字符。 默认取值：不涉及。 |
请求示例
GET https://{endpoint}/v1/agreement
响应示例
状态码：200
租户注册协议响应体。
{
"agreements" : [ {
"agreement_name" : "test_name",
"agreement_version" : "v1"
} ]
}
状态码：400
BadRequest
{
"error_code" : "common.01000001",
"error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}
状态码：401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码：403
Forbidden
{
"error" : {
"code" : "403",
"message" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
},
"error_code" : 403,
"error_msg" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
}
状态码：404
NotFound
{
"error_code" : "common.01000001",
"error_msg" : "response status exception, code: 404"
}
状态码：408
Request Time-out
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
}
状态码：500
InternalServerError
{
"error_code" : "common.00000500",
"error_msg" : "internal error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
租户注册协议响应体。 |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
NotFound |
|
408 |
Request Time-out |
|
500 |
InternalServerError |
错误码
请参见错误码。
