All Products
Search
Document Center

:GetCatalogSettings

Last Updated:Jan 15, 2025

To obtain the configurations of Data Lake Catalog, you must assume the admin role or above.

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
dlf:GetCatalogSettingsget
*All Resources
*
    none
none

Request syntax

GET /api/metastore/catalogs/settings HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
CatalogIdstringNo

The ID of the data directory.

1344371

Response parameters

ParameterTypeDescriptionExample
object

Returns the message body.

RequestIdstring

The request ID.

B7F4B621-E41E-4C84-B97F-42B5380A32BB
Codestring

The response code.

OK
Messagestring

The response message.

.
Successboolean

Indicates whether the request was successful. Valid values: Valid values:

  • true
  • false
true
CatalogSettingsCatalogSettings

Data lake-related configurations.

Examples

Sample success responses

JSONformat

{
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Code": "OK",
  "Message": ".",
  "Success": true,
  "CatalogSettings": {
    "Config": {
      "key": "{\n\"auth.permission.check.enable\":\n\"true\",\n\"auth.super.principal\":\n\"acs:ram::[aliyunAccountId]:role/aliyundlfworkflowdefaultrole\"\n}"
    }
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history