Updated on 2024-09-04 GMT+08:00

Batch Deleting Source Server Records

Function

This API is used to delete source server records in batches. 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

POST /v3/sources/delete

Request

Table 1 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1 character

Maximum length: 16,384 characters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

The IDs of all source servers to be deleted.

Minimum length: 0 characters

Maximum length: 255 characters

Array length: 0 to 65,535 characters

Response

None

Example Request

This example deletes source servers ec2a894f-0d92-47c5-ac22-168ef61dxxxx and 5f13089f-799f-4f33-b3e1-c499397dxxxx in a batch.

POST https://{endpoint}/v3/sources/delete

{
  "ids" : [ "ec2a894f-0d92-47c5-ac22-168ef61dxxxx", "5f13089f-799f-4f33-b3e1-c499397dxxxx" ]
}

Example Response

None

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.