All Products
Search
Document Center

Hologres:UpdateBackupDataDesc

Last Updated:May 21, 2026

Updates the description of a backup.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /api/v1/backups/{id}/desc HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

id

string

No

The backup ID.

1597404937581527041

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID.

cn-hangzhou

body

object

No

The request body.

instanceId

string

No

The instance ID.

hgpostcn-cn-721344a2z001

desc

string

No

The backup description.

back up test

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

87060182-4B69-5C3D-B3A1-A944D20138A7

Data

boolean

The result of the operation. A value of 'true' indicates that the backup description was updated successfully.

true

Success

boolean

Indicates whether the request was successful.

true

ErrorCode

string

The error code.

404

ErrorMessage

string

The error message.

Internal server error.

HttpStatusCode

string

The HTTP status code.

200

Examples

Success response

JSON format

{
  "RequestId": "87060182-4B69-5C3D-B3A1-A944D20138A7",
  "Data": true,
  "Success": true,
  "ErrorCode": "404",
  "ErrorMessage": "Internal server error.",
  "HttpStatusCode": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.