Help Center> Distributed Cache Service> API Reference> Lifecycle Management APIs> Batch Deleting DCS Instances
View PDF

Batch Deleting DCS Instances

Function

This API is used to delete multiple DCS instances at a time.

URI

DELETE /v1.0/{project_id}/instances?allFailure={allFailure}

Table 1 describes the parameters.
Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Project ID.

allFailure

String

No

An indicator of whether all DCS instances failed to be created will be deleted. Options:

Options:

  • true: all instances that fail to be created are deleted. In this case, the instances parameter in the request can be empty.
  • false or other values: The DCS instances specified by the instances parameter in the API request will be deleted.

Request

Request parameters

Table 2 describes the request parameters.
Table 2 Parameter description

Parameter

Type

Mandatory

Description

instances

Array

No

IDs of DCS instances to be deleted.

This parameter is set only when the allFailure parameter in the URI is set to false or another value.

A maximum of 50 instances can be deleted at a time.

Request URL:

DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances?allFailure={allFailure}

Example request with allFailure set to false:

{
    "instances": [
        "54602a9d-5e22-4239-9123-77e350df4a34",
        "7166cdea-dbad-4d79-9610-7163e6f8b640"
    ]
}

Response

Response parameters

If the value of the allFailure parameter in the URI is true, all DCS instances that the tenant specified by project_id that failed to create are deleted and an empty response is then returned. If the value of the allFailure parameter in the URI is false, the DCS instances specified by the instances parameter in the API request are deleted and a response containing the parameter in Table 3 is then returned.
Table 3 Parameter description

Parameter

Type

Description

results

Array

For details about how to delete an instance, see Table 4.
Table 4 results parameter description

Parameter

Type

Description

instance

String

DCS instance ID.

result

String

Instance deletion result. Options: success and failed

Example response

{
    "results": [
        {
            "instance": "54602a9d-5e22-4239-9123-77e350df4a34",
            "result": "success"
        },
        {
            "instance": "7166cdea-dbad-4d79-9610-7163e6f8b640",
            "result": "success"
        }
    ]
}

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.

Table 5 Status codes

Status Code

Description

200

DCS instances deleted successfully.

204

DCS instances that failed to be created are cleared successfully.