邀请联盟成员 - BatchInviteMembersToChannel
功能介绍
批量邀请联盟成员加入通道,此操作会向被邀请方发出邀请通知
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/{project_id}/members/invitations
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户从IAM申请到的项目ID,一般为32位字符串 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
账号token |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
bcs_id |
是 |
String |
发出邀请的服务实例ID |
|
channel_name |
是 |
String |
邀请加入的通道名 |
|
invitor_username |
否 |
String |
发出邀请的租户名 |
|
invited_userinfo |
是 |
Array of InvitedDomain objects |
被邀请的用户列表 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
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 |
错误描述 |
请求示例
paas_bcs_c00218797_02邀请方channel通道邀请用户xxx
{
"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 |
错误码
请参见错误码。