获取全部通知 - ListNotifications
功能介绍
获取全部通知
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/notifications
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户从IAM申请到的项目ID,一般为32位字符串 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 账号token |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| notifications | Array of NotificationList objects | 通知列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| channel_name | String | 通道名称 |
| status | String | 当前状态 |
| updated_time | String | 更新时间 |
| tc3_need | Boolean | 是否开启可信 |
| invitor_info | InvitorInfo object | 邀请方信息 |
| invitee_info | InviteeInfo object | 被邀请方信息 |
| hide | Long | 是否删除 |
| invitee_orgs | Array of OrganizationV2 objects | 被邀请的组织信息 |
| read_status | Long | 阅读状态值 |
| cross_version_upgrade | String | 跨版本进行升级 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| invitor_id | String | 邀请方用户id |
| invitor_name | String | 邀请方用户名 |
| invitor_bcs_id | String | 邀请方的服务实例id |
| invitor_bcs_name | String | 邀请方的服务实例名 |
| invitor_consensus | String | 邀请方的共识 |
| invitor_project_id | String | 邀请方的projectID |
| invitor_cluster_type | String | 邀请方的集群类型 |
| invitor_database_type | String | 邀请方数据库类型 |
| invitor_signature_algorithm | String | 邀请方的签名算法 |
| invitor_fabric_version | String | 邀请方的fabric版本 |
| order_fade_enabled | Boolean | 是否允许共识节点老化 |
| order_fade_cache | Long | 共识节点的老化阈值 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| invitee_id | String | 被邀请用户id |
| invitee_name | Long | 被邀请租户名称 |
| invitee_bcs_name | String | 被邀请的服务实例名称 |
| invitee_bcs_id | String | 被邀请的服务实例id |
| invitee_project_id | String | 被邀请的项目id |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 组织名称 |
| name_hash | String | 组织hash |
| node_count | Integer | 组织节点 |
| status | String | 组织状态 |
| status_detail | String | 状态描述 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
请求示例
无
响应示例
状态码:400
Bad Request
{
"error_code" : "BCS.4006014",
"error_msg" : "Invalid Parameter quotasType : ecs"
} 状态码:401
Unauthorized
{
"error_code" : "BCS.4010401",
"error_msg" : "Incorrect token or token resolution failed"
} 状态码:403
Forbidden
{
"error_code" : "BCS.4030403",
"error_msg" : "No permissions to request this method"
} 状态码:404
Not Found
{
"error_code" : "BCS.4040404",
"error_msg" : "Not Found:the url is not found"
} 状态码:500
InternalServerError
{
"error_code" : "BCS.5000500",
"error_msg" : "Internal Server Error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Ok |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | InternalServerError |
错误码
请参见错误码。