tencent cloud

DescribeDatasourceList
Last updated: 2025-11-13 21:02:46
DescribeDatasourceList
Last updated: 2025-11-13 21:02:46

1. API Description

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

This API is used to query a data source list.

A maximum of 100 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: DescribeDatasourceList.
Version Yes String Common Params. The value used for this API: 2022-01-05.
Region No String Common Params. This parameter is not required.
ProjectId Yes Integer None.
AllPage No Boolean Returns all pages and defaults to false.
DbName No String Database name search.
PageNo No Integer None.
PageSize No Integer None.
Keyword No String Search keywords.
PermissionType No Integer Permission filter (0: all permissions, 1: access permission, 2: edit permission).

3. Output Parameters

Parameter Name Type Description
ErrorInfo ErrorInfo Custom error information object.
Note: This field may return null, indicating that no valid values can be obtained.
Data DatasourceInfoData List details.
Note: This field may return null, indicating that no valid values can be obtained.
Extra String Information.
Msg String Information.
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 Example

This example shows you the example.

Input Example

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

{
    "ProjectId": 1982493789748932,
    "AllPage": false,
    "DbName": "DbName",
    "PageNo": 1982493789748932,
    "PageSize": 1982493789748932,
    "Keyword": "Keyword",
    "PermissionType": 1982493789748932
}

Output Example

{
    "Response": {
        "Data": {
            "List": null,
            "Total": 0,
            "TotalPages": 0
        },
        "Extra": "",
        "Msg": "success",
        "RequestId": "3a66482b-7460-4d22-95bc-eae8c28568e4"
    }
}

Example2 success

This example shows you how to query the data source list.

Input Example

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

{
    "ProjectId": 11
}

Output Example

{
    "Response": {
        "RequestId": "b8116ab8-92e8-4370-b3d5-6cb464b83609",
        "Extra": "",
        "Data": {
            "List": null,
            "Total": 0,
            "TotalPages": 0
        },
        "Msg": "success"
    }
}

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
AuthFailure CAM signature/authentication error.
FailedOperation Operation failed.
InternalError Internal error.
InternalError.Internal Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
LimitExceeded The quota limit is exceeded.
MissingParameter Parameters are missing.
MissingParameter.MissingParam The required parameter is missing.
OperationDenied Operation denied.
RequestLimitExceeded Too many and frequent requests.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.Authorize Permission error.
UnauthorizedOperation.Inactive User is not enabled.
UnauthorizedOperation.UserNotExist The user does not exist.
UnknownParameter Unknown parameter error.
UnsupportedOperation The operation is not supported.
UnsupportedOperation.BIError Default business exception.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback