UpdateDataLakeDatabase - Data Management - Alibaba Cloud Documentation Center

Updates the information about a database in a data lakehouse.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:UpdateDataLakeDatabase	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CatalogName	string	Yes	The catalog name.	hive
DbName	string	Yes	The name of the database that you want to query.	default
Description	string	No	The description of the database.	test
Location	string	Yes	The storage path of the database. Supports the OSS, S3, and S3A protocols.	oss://path/to/database
Parameters	object	No	The key-value pairs of the database attributes.
	string	No	The parameter key and value.	{"key":"value"}
DataRegion	string	Yes	The region where the data lake resides.	cn-hangzhou
Tid	long	No	The ID of the tenant. Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	3***
WorkspaceId	long	No	The workspace ID.	12****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use the request ID to locate logs and troubleshoot issues.	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request succeeded. false: The request failed.	true
Database	DLDatabase	The database details.

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Database": {
    "Description": "Default database for catalog hive",
    "Parameters": {
      "test": "test",
      "test2": 1
    },
    "DbId": 19,
    "CatalogName": "hive",
    "Name": "default",
    "Location": "oss://xxx"
  }
}

Error codes

For a list of error codes, visit the Service error codes.