Exiting a Consortium
Function
This API is used to exit a consortium.
URI
PUT /v2/{project_id}/members/quit
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Account token. Minimum: 1 Maximum: 32768 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
inviter_bcsid |
Yes |
String |
BCS service ID of the inviting party. You can obtain it by calling the Querying the BCS Service List API. |
inviter_projectid |
Yes |
String |
Project ID of the inviting party. Log in to the BCS console as an inviting party, click the account name, and click My Credentials > API Credentials to obtain the Project ID in the Projects area. |
inviter_domainid |
Yes |
String |
Tenant ID of the inviting party. Log in to the BCS console as an inviting party, click the account name, and click My Credentials > API Credentials to obtain the Account ID. |
inviter_username |
Yes |
String |
Tenant name of the inviting party. Log in to the BCS console as an inviting party, click the account name, and click My Credentials > API Credentials to obtain the Account Name. |
channel_name |
Yes |
String |
Consortium channel name. On the BCS management plane, click Member Management to view the channel used in the invitation. |
invitee_bcsid |
Yes |
String |
BCS service ID of the invitee. You can obtain it by calling the Querying the BCS Service List API. |
invitee_projectid |
Yes |
String |
Project ID of the invitee. Log in to the BCS console as an invitee, click the account name, and click My Credentials > API Credentials to obtain the Project ID in the Projects area. |
invitee_domainid |
Yes |
String |
Tenant ID of the invitee. Log in to the BCS console as an invitee, click the account name, and click My Credentials > API Credentials to obtain the Account ID. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
String |
Request result. |
operation_id |
String |
Operation record ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Example Requests
{ "inviter_bcsid" : "a30962b6-xxxxx-f7ff1a0ec561", "inviter_projectid" : "b45a57xxxxx8a5", "inviter_domainid" : "a38c7xxxxd374d", "inviter_username" : "bcs-test", "channel_name" : "channel", "invitee_bcsid" : "e97ae066-xxxxx-f6bdb4fd3df1", "invitee_projectid" : "e64e7xxxxx65e1", "invitee_domainid" : "a38c7xxxxx374d" }
Example Responses
Status code: 200
Ok
{ "result" : "success", "operation_id" : "BCSSVC01-03-1617158790255323683" }
Status code: 400
Bad Request
{ "error_code" : "BCS.4006003", "error_msg" : "Invalid Parameter notification status" }
Status code: 401
Unauthorized
{ "error_code" : "BCS.4010401", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" }
Status code: 404
Not Found
{ "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" }
Status code: 500
InternalServerError
{ "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }
Status Codes
Status Code |
Description |
---|---|
200 |
Ok |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
InternalServerError |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot