tencent cloud

Tencent Cloud WeData

ドキュメントTencent Cloud WeDataAPI DocumentationAsset APIsListSchema

ListSchema

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-03-02 12:27:46

1. API Description

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

This API is used to obtain the asset database Schema information.

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: ListSchema.
Version Yes String Common Params. The value used for this API: 2025-08-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
PageNumber Yes Integer Page number, starting from 1.
PageSize Yes Integer Pagination size. maximum 500.
CatalogName No String Directory name.
DatasourceId No Integer Data source ID.
DatabaseName No String Database name.
Keyword No String Search by database schema keyword.

3. Output Parameters

Parameter Name Type Description
Data ListSchemaPage Paging data
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 Querying the Schema List

Query the Schema list

Input Example

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

{
    "PageNumber": 1,
    "PageSize": 10,
    "CatalogName": "0",
    "DatasourceId": 8499,
    "DatabaseName": "orcl",
    "Keyword": "dev"
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "DatabaseName": "orcl",
                    "Guid": "RpMuByxDK0C22iZeDOBMsA",
                    "Name": "WEDATA_DEV"
                }
            ],
            "PageCount": 0,
            "PageNumber": 1,
            "PageSize": 1,
            "TotalCount": 1
        },
        "RequestId": "283e76af-5333-4fe8-a968-b0370092e0cf"
    }
}

Example2 Query Database Schema Via OpenAPI

Query database Schema via OpenAPI

Input Example

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

{
    "PageNumber": 1,
    "PageSize": 2,
    "Keyword": "tab"
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "DatabaseName": "my_database",
                    "Guid": "oJRdeGawTgyfMhtn8yvxHA",
                    "Name": "my_database"
                },
                {
                    "DatabaseName": "table_datatbases",
                    "Guid": "NJovXubQQXmb6cao__HYdA",
                    "Name": "table_datatbases"
                }
            ],
            "PageCount": 0,
            "PageNumber": 1,
            "PageSize": 2,
            "TotalCount": 4
        },
        "RequestId": "c6781fb3-5516-4a9b-ba06-2181481cd5ea"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

前の記事へ: ListProcessLineage次の記事へ: ListTable

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック