查询当前系统协议 - ShowAgreementRule
功能介绍
查询当前系统协议。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 租户token。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
X-request-id | String | 请求ID,定位辅助信息。 |
参数 | 参数类型 | 描述 |
|---|---|---|
agreement_rules | Array of AgreementRule objects | 系统协议列表。 |
参数 | 参数类型 | 描述 |
|---|---|---|
agreement_name | String | 协议名称。 |
agreement_display_name | String | 协议展示名称。 |
agreement_version | String | 协议版本。 |
agreement_url | String | 协议链接。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
状态码:403
参数 | 参数类型 | 描述 |
|---|---|---|
error | Error object | 错误信息。 |
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
title | String | 标题。 |
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
title | String | 标题。 |
message | String | 错误信息。 |
code | String | 状态码。 |
状态码:404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
状态码:408
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
请求示例
GET https://{endpoint}/v1/{project_id}/agreement-rule 响应示例
状态码:200
系统协议响应体
{
"agreement_rules" : [ {
"agreement_name" : "agreement AAA",
"agreement_display_name" : "AAA",
"agreement_version" : "v1",
"agreement_url" : "https://AAA"
}, {
"agreement_name" : "agreement BBB",
"agreement_display_name" : "BBB",
"agreement_version" : "v1",
"agreement_url" : "https://BBB"
} ]
} 状态码:400
Bad Request
{
"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",
"error_code" : null,
"error_msg" : null,
"title" : "Forbidden"
},
"error_code" : "403",
"error_msg" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
} 状态码:404
Not Found
{
"error_code" : "common.01000001",
"error_msg" : "response status exception, code: 404"
} 状态码:408
Request Timeout
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
} 状态码:500
Internal Server Error
{
"error_code" : "common.00000500",
"error_msg" : "internal error"
} 状态码
状态码 | 描述 |
|---|---|
200 | 系统协议响应体 |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
408 | Request Timeout |
500 | Internal Server Error |
错误码
请参见错误码。

