更新时间:2023-04-24 GMT+08:00

邀请联盟成员

功能介绍

批量邀请联盟成员加入通道,此操作会向被邀请方发出邀请通知

URI

POST /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

邀请加入的通道名

invitor_username

String

发出邀请的租户名

invited_userinfo

Array of InvitedDomain objects

被邀请的用户列表

表4 InvitedDomain

参数

是否必选

参数类型

描述

invited_user

String

被邀请方租户

响应参数

状态码: 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" : "ba0fc16d-c752-9ac4-7a43-7a84443e0a06",
  "channel_name" : "channel",
  "invitor_username" : "paas_bcs_c00218797_02",
  "invited_userinfo" : [ {
    "invited_user" : "xxx"
  } ]
}

响应示例

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

错误码

请参见错误码