Rejoining a Desktop to the AD Domain
Function
Rejoins a Windows desktop to the AD domain. 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.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
POST /v2/{project_id}/desktops/{desktop_id}/rejoin-domain
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. |
desktop_id | Yes | String | Desktop ID. |
Request Parameters
None
Response Parameters
Status code: 202
Parameter | Type | Description |
|---|---|---|
job_id | String | Task ID. |
Status code: 404
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code, which is returned upon failure. |
error_msg | String | Error message. |
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: 409
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code, which is returned upon failure. |
error_msg | String | Error message. |
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 message. |
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 message. |
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
None
Example Responses
Status code: 202
A task for rejoining the domain has been created.
{
"job_id" : "string"
} Status Codes
Status Code | Description |
|---|---|
202 | A task for rejoining the domain has been created. |
404 | Desktop not found. |
409 | Operation conflict. |
412 | The desktop cannot rejoin the domain. |
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
