Deleting a Source Server Record
Function
This API is used to delete the record of a source server with a specified ID from the SMS console. Once the information about a source server is deleted, you can add the information about the source server to the SMS console again only by restarting the migration Agent on the source server.
Calling Method
For details, see Calling APIs.
URI
DELETE /v3/sources/{source_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
source_id |
Yes |
String |
The ID of the source server in SMS. Minimum length: 0 characters Maximum length: 255 characters |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum length: 1 character Maximum length: 16,384 characters |
Response
Status code: 200
Parameter |
Type |
Description |
---|---|---|
- |
String |
The information about the source server with a specified ID was deleted. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
The error code. Minimum length: 0 characters Maximum length: 255 characters |
error_msg |
String |
The error message. Minimum length: 0 characters Maximum length: 255 characters |
encoded_authorization_message |
String |
Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters |
error_param |
Array of strings |
Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20 |
details |
Array of details objects |
The error message. Array length: 1 to 20 |
Example Request
This example deletes the record of source server whose ID is 1a6d1e0b-62e5-4376-b59f-ff2fd569xxxx.
DELETE https://{endpoint}/v3/sources/1a6d1e0b-62e5-4376-b59f-ff2fd569xxxx
Example Response
Status code: 403
Authentication failed.
{ "error_code" : "SMS.9004", "error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.", "encoded_authorization_message" : "XXXXXX", "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ], "details" : [ { "error_code" : "SMS.9004", "error_msg" : "You do not have permission to perform action XXX on resource XXX." } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
The information about the source server with a specified ID was deleted. |
403 |
Authentication failed. |
Error Codes
For details, 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