Skip to main content
API Explorer|API Explorer
Platform O&M/Backup Management/Backup Service (Plus)/Backup Service Operations
POSTBackup Service OperationsSince 3.0.0SynchronousAuth Required

CreateDatabaseBackup

CreateDatabaseBackup

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameStringRequired

      The name of the database backup.

    • descriptionStringRequired

      The detailed description of the backup.

    • backupStorageUuidStringRequired

      The UUID of the backup storage.

    • resourceUuidString

      Optional.

  • systemTagsList

    Optional.

  • userTagsList

    Optional.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryDatabaseBackupInventoryRequired

    See inventory

    • uuidStringRequired

      The UUID of the database backup.

    • nameStringRequired

      The name of the backup.

    • descriptionStringRequired

      The detailed description of the backup.

    • stateStringRequired

      当前状态。

    • statusStringRequired

      状态信息。

    • sizeLongRequired

      返回记录数。

    • metadataStringRequired

      附加元数据。

    • createDateTimestampRequired

      The time when the backup was created.

    • lastOpDateTimestampRequired

      The time when the backup was last modified.

    • backupStorageRefsListRequired

      See backupStorageRefs

      • databaseBackupUuidStringRequired

        数据库备份UUID。

      • backupStorageUuidStringRequired

        The UUID of the backup storage.

      • installPathStringRequired

        安装路径。

      • exportUrlStringRequired

        导出地址。

      • statusStringRequired

        状态信息。

      • createDateTimestampRequired

        The time when the backup was created.

      • lastOpDateTimestampRequired

        The time when the backup was last modified.

Endpoint

POST/zstack/v1/database-backups

/zstack/v1/database-backups

Operation ID

CreateDatabaseBackup

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/database-backups' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","backupStorageUuid":"<backupStorageUuid>","resourceUuid":"<resourceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "7decf4a7cb7c41dabc57446df2784476", "name": "zsdb", "state": "Enabled", "size": 1000.0, "metadata": "{\"version\":\"3.0.0\"}", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }

Change History

This API has no change history records yet.

View all change history