Querying Details About a Specified Catalog
Function
This API is used to query details about a specified DLI catalog.
URI
GET /v3/{project_id}/catalogs/{catalog_name}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID, which is used for resource isolation. For how to obtain a project ID, see Obtaining a Project ID. |
catalog_name |
Yes |
String |
Catalog mapping name on DLI. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
is_success |
Boolean |
Whether the request is successful. |
name |
String |
Catalog mapping name on DLI. |
create_time |
Long |
Creation time. |
parameters |
Map<String,String> |
Catalog structure information. For details, see Table 3. |
description |
String |
Catalog description. |
status |
String |
Catalog status. The options are:
|
Parameter |
Type |
Description |
---|---|---|
external_catalog_name |
String |
Name of an external catalog. |
type |
String |
Catalog type. Currently, the value can only be lakeformation. lakeformation: Metadata of the LakeFormation type is used. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Failure cause. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Failure cause. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Failure cause. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Failure cause. |
Example Request
None
Example Response
{ "is_success": true, "name": "dli_catalog_test1", "create_time": 1709605019153, "parameters": { "type": "lakeformation", "external_catalog_name": "catalog_test1" }, "description": "" }
Status Codes
Status Code |
Description |
---|---|
200 |
The request is successful. |
400 |
Request error. |
403 |
Access to the requested page is forbidden. |
404 |
The server cannot find the requested page. |
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.