tencent cloud

APIs

ListCatalogs

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-10-11 15:48:56

1. API Description

Domain name for API request: databuddy.intl.tencentcloudapi.com.

Pagination fetch data catalog list

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ListCatalogs.
Version Yes String Common Params. The value used for this API: 2026-07-15.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
WorkspaceId Yes String

Workspace unique id

MaxResults No Integer

Maximum number of result entries

PageToken No String

Pagination token

Types.N No Array of String

catalog type. Valid values: TABLE, MODEL, VOLUME

CurrentWorkspaceOnly No Boolean

Whether to return only those in the current workspace that are authorized. If false, it additionally returns the catalogs that the current user has permission to manage.

FetchOption No FetchOption

Data access option. Selectable. Controls whether to return permission information and filter by permission.

CatalogSources.N No Array of String Data catalog source filter criteria (additional field in Fusion Edition). For values, see CatalogSourceEnum. Empty array or not passed: only tclake is queried. ["METALAKE"]: only tclake is queried. ["CONNECTION"]: only the analytics edition ana_catalog is queried. ["METALAKE","CONNECTION"]: merged and returned.

3. Output Parameters

Parameter Name Type Description
Data ListCatalogsRsp

Operation result

RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Filter examples by type

Filter examples by type

Input Example

POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListCatalogs
<Common request parameters>

{
    "WorkspaceId": "17697667906247629",
    "MaxResults": 5
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "AssetGuid": "tccatalog.v1.uid1682010588499561186@251436191_ap-guangzhou_CATALOG",
                    "Audit": {
                        "CreatedAt": "1779363594232",
                        "Creator": "zhipengxue2",
                        "CreatorName": "zhipengxue2",
                        "LastModifiedAt": "1779363606061",
                        "LastModifier": "700002657504",
                        "LastModifierName": "zhipengxue2"
                    },
                    "Comment": "",
                    "CurrentWorkspacePermissionLevel": 2,
                    "Id": "1aa25d21-335f-4dad-a7e6-fda752d7804a",
                    "Identifier": "tccatalog.v1.uid1682010588499561186",
                    "IsExternal": false,
                    "MetaOwner": {
                        "FullName": "afa",
                        "Owner": "700002657504",
                        "OwnerName": "zhipengxue2",
                        "OwnerType": "user"
                    },
                    "Name": "afa",
                    "Operator": "zhipengxue2",
                    "Properties": [
                        {
                            "Key": "gravitino.bypass.catalog-impl",
                            "Value": "org.apache.iceberg.hive.TCLakeHiveCatalog"
                        }
                    ],
                    "Status": "2",
                    "Tags": [],
                    "Type": "TABLE"
                }
            ],
            "NextPageToken": "eyJvZmZzZXQiOjV9"
        },
        "RequestId": "9362aef9-3934-4257-9b87-89e3078d281d"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.BizException Business logic error.
InternalError.FailedOperation Operation failed
InvalidParameter.InvalidParameter Incorrect parameter.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan