Update Catalog¶

Update the Catalog’s name and description.

HTTP
POST $CLOUDSIGMA_API_BASE/catalog/update

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First query the catalog list to obtain the target catalog ID.

Set the operation-specific values used in the request:

$CATALOG_ID: Catalog ID to update.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/catalog/update" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$CATALOG_ID"',
    "name": "<CATALOG_NAME>",
    "description": "<CATALOG_DESCRIPTION>"
  }'

Parameter reference

Request body

Parameter	Type	Required	Description
`id`	integer	Yes	Catalog ID.
`name`	string	Yes	New name, must be a valid identifier.
`description`	string	No	Updated description.

Successful response¶

Returns 200 on success, data is null. Then read the details to confirm the change.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": null
}

Field reference

The response fields are as follows.

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data`	null	Fixed to `null` when the update is successful.

Error response¶

Response example

JSON
{
  "code": "ErrReadonlySystemCatalog",
  "msg": "系统 Catalog 为只读",
  "data": null
}

Field reference

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`ErrParamInvalid`	The request body is invalid, the ID is invalid, or the name is not a valid identifier.	Check `id` and `name`.
`403`	`ErrForbidden`	The current identity does not have update permissions.	Requesting permission to `catalog.update`.
`409`	`ErrAlreadyExists`	The new name is already used by other catalogs.	Change the name and try again.
`409`	`ErrReadonlySystemCatalog`	Targets a read-only system catalog.	Do not modify this Catalog.
`500`	`ErrServer`	The server failed to update the Catalog.	Try again later.

Follow-up operations¶

Query Catalog details to confirm the change.

Last updated on Sep 15, 2026