ListCatalogs-阿里云帮助中心

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
NextToken	string	No	Pagination token	0
Limit	integer	No	Items per page	10

Response elements

Element	Type	Description	Example
	object
Message	string	Response message	Operation success
RequestId	string	Request ID	34AD682D-5B91-5773-8132-AA38C130****
Data	object	Response data
Catalogs	array	Catalog list
	Catalog	Catalog list details
NextToken	string	Next page token	10
Total	integer	Total count	1
Code	string	Response code, 200 indicates success	200
Success	boolean	Whether the operation was successful	true

Examples

Success response

JSON format

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

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.