GetCatalog

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 parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	Data catalog name	my_catalog
ClientToken	string	No	Idempotency token	1e9b8f60-3a2c-4d7e-9f1b-8c3d5e7a2b4f

Response elements

Element	Type	Description	Example
	object
Message	string	Response message	Operation success
RequestId	string	Request ID	34AD682D-5B91-5773-8132-AA38C130****
Code	string	Response code. 200 indicates success.	200
Success	boolean	Indicates whether the operation was successful	true
Data	Catalog	Catalog details

Examples

Success response

JSON format

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Code": "200",
  "Success": true,
  "Data": {
    "Name": "my_catalog",
    "Type": "RELATIONAL",
    "Provider": "EventHouse",
    "Comment": "测试数据目录",
    "Properties": {
      "IndexPattern": "my-index-*"
    },
    "ConnectionName": "my_connection"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.