tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeFieldBasicInfo

Last updated: 2024-06-21 15:11:59

1. API Description

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

Metadata Model - Field Basic Information Query Interface

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: DescribeFieldBasicInfo.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
PageNumber No Integer Page Number
PageSize No Integer Page Size
Filters.N No Array of Filter Filter field
OrderFields.N No Array of OrderField Sort Fields

3. Output Parameters

Parameter Name Type Description
ColumnBasicInfoList Array of ColumnBasicInfo Field Metadata
Note: This field may return null, indicating that no valid value can be obtained.
TotalCount Integer Total number of items
Note: This field may return null, indicating that no valid value can be obtained.
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 1

1

Input Example

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

{
    "PageNumber": 0,
    "PageSize": 0,
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ]
        }
    ],
    "OrderFields": [
        {
            "Name": "abc",
            "Direction": "abc"
        }
    ]
}

Output Example

{
    "Response": {
        "ColumnBasicInfoList": [
            {
                "TableId": "abc",
                "DatasourceId": "abc",
                "DatasourceName": "abc",
                "DatabaseId": "abc",
                "DatabaseName": "abc",
                "TableName": "abc",
                "ColumnName": "abc",
                "DataType": "abc",
                "ColumnType": "abc",
                "ColumnDefault": "abc",
                "ColumnKey": "abc",
                "ColumnPosition": 0,
                "ColumnComment": "abc",
                "StoreType": "abc",
                "ProjectId": "abc",
                "ProjectName": "abc",
                "ProjectDisplayName": "abc",
                "CreateTime": "abc",
                "UpdateTime": "abc"
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

Example2 Error 1

Error 1

Input Example

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

{
    "PageNumber": 1,
    "PageSize": 1,
    "Filters": [
        {
            "Name": "1",
            "Values": [
                "1"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "Error": {
            "Code": "InternalError",
            "Message": "Internal service error. Please try again later."
        },
        "RequestId": "76e7bf2b-c516-4a4c-97ba-f0b788097c1f"
    }
}

Example3 Error 2

Error 2

Input Example

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

{
    "PageNumber": 1,
    "PageSize": 1,
    "Filters": [
        {
            "Name": "1",
            "Values": [
                "1"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "Error": {
            "Code": "InternalError",
            "Message": "Internal service error. Please try again later."
        },
        "RequestId": "235a9ac1-1037-4f8a-befe-9765a29480cd"
    }
}

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
FailedOperation Operation Failure.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy