Updating a Desktop SID
Function
If the desktop SID is different from the SID of the Windows AD, update the desktop SID to make both SIDs the same. This API is used when the desktop is not in the domain.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
PUT /v2/{project_id}/desktops/sids
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
desktop_ids |
Yes |
Array of strings |
VM list. |
Response Parameters
Status code: 200
Desktop SID updated.
Status code: 202
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Task ID. |
Status code: 204
Desktop SID not changed.
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
error_detail |
String |
Error details. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 412
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
error_detail |
String |
Error details. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: default
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
error_detail |
String |
Error details. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Example Requests
/v2/{project_id}/desktops/sids { "desktop_ids" : [ "48f3531f-6cde-49c7-8756-7f697a41241a", "234f-6cde-4fcxxx7-8756-723acca1241ac" ] }
Example Responses
Status code: 202
A task for updating SIDs in batches has been created.
{ "job_id" : "string" }
Status Codes
Status Code |
Description |
---|---|
200 |
Desktop SID updated. |
202 |
A task for updating SIDs in batches has been created. |
204 |
Desktop SID not changed. |
400 |
Desktop ID not found. |
412 |
Desktop SID cannot be updated. |
default |
Default error response. |
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