Chen, Junjie a03981f7be DCS API 20230220 Version

Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

2024-04-22 14:08:39 +00:00

11 KiB

Raw Permalink Blame History

Backing Up a DCS Instance

Function

This API is used to back up a specified DCS instance.

Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.

URI

POST /v1.0/{project_id}/instances/{instance_id}/backups

Table 1 describes the parameters.

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
project_id	String	Yes	Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
instance_id	String	Yes	DCS instance ID.

Request

Request parameters

Table 2 describes the request parameters.

**Table 2** Parameter description
Parameter	Type	Mandatory	Description
remark	String	No	Description of DCS instance backup.

Example request

Request URL:

POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups

Example:
```
{
    "remark": "Backup instances"
}
```

Response

Response parameters

Table 3 describes the response parameter.

**Table 3** Parameter description
Parameter	Type	Description
backup_id	String	ID of the backup record

Example response

{
    "backup_id": "548ceeff-2cbb-47ab-9a1c-7b085a8c08d7"
}

Status Code

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

**Table 4** Status code
Status Code	Description
200	Backup task created successfully.

Parent topic: Backup and Restoration APIs

11 KiB Raw Permalink Blame History