更新时间:2024-07-03 GMT+08:00
分享

删除邀请成员信息

功能介绍

可通过此接口批量取消邀请或删除对已退出或拒绝加入或解散的成员邀请信息

调试

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

URI

DELETE /v2/{project_id}/members/invitations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的项目ID,一般为32位字符串

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

账号token

最小长度:1

最大长度:32768

表3 请求Body参数

参数

是否必选

参数类型

描述

bcs_id

String

邀请实例id

channel_name

String

邀请加入的通道名

invited_userinfo

Array of InvitationDetail objects

被邀请的用户列表,对应信息可通过获取联盟成员列表(ListMembers)接口查询,或被邀请方已加入联盟,或邀请状态为released时,需填写准确的被邀请方bcs实例id和邀请状态

表4 InvitationDetail

参数

是否必选

参数类型

描述

invited_user

String

被邀请方租户名,IAM用户名

status

String

邀请状态,可选:已退出(quit),等待中(waiting),已拒绝(reject),已解散(released),其他状态不允许删除

枚举值:

  • quit

  • waiting

  • reject

  • released

invited_bcs_id

String

被邀请方服务实例ID

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

result

String

请求成功的结果

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

{
  "bcs_id" : "83d85ea4-0f97-3bb7-07e2-4ad4b5a9f39d",
  "channel_name" : "chan2",
  "invited_userinfo" : [ {
    "invited_user" : "bcstest02",
    "status" : "quit",
    "invited_bcs_id" : "11ba0ae0-2986-72d5-9049-43998c16fe86"
  } ]
}

响应示例

状态码: 200

Ok

{
  "result" : "success"
}

状态码: 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

错误码

请参见错误码

相关文档