tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateDataSource

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

1. API Description

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

Create Data Source

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: CreateDataSource.
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.
Name Yes String Data Source Name, cannot be empty under the same SpaceName
Category Yes String Data Source Category: Binding Engine, Binding Database
Type Yes String Data Source Type: enumerated values
OwnerProjectId Yes String Project ID
OwnerProjectName Yes String Project Name
OwnerProjectIdent Yes String Project Name (Chinese)
BizParams No String Configuration Information Extension of Business Data Source
Params No String Data source configuration information, stored as JSON KV. The KV storage information varies according to the data source type
Description No String Data source description information
Display No String Data Source Display Name, for visual inspection
DatabaseName No String If the data source list is bound to a database, then it is the database name
Instance No String Instance ID of the data source engine, e.g., CDB Instance ID
Status No Integer Visibility of the data source, where 1 is visible and 0 is not visible. Default is 1
ClusterId No String Name of the business space to which the data source belongs
Collect No String Collection Status
COSBucket No String COS Bucket Information
COSRegion No String cos region
ConnectResult No String Connection Test Result
DevelopmentParams No String Development Environment Data Source Configuration

3. Output Parameters

Parameter Name Type Description
Data Integer Primary Key ID
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 Sample

Input Example

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

{
    "BizParams": "string",
    "Category": "DB",
    "DatabaseName": "db",
    "Description": "string",
    "Display": "saga",
    "Name": "striaasdgng",
    "Params": "string",
    "ClusterId": "cdb-xxasfsdg6d",
    "Status": 1,
    "Type": "CLICKHOUSE",
    "Collect": "1",
    "OwnerProjectId": "100265651",
    "OwnerProjectName": "pprasf",
    "OwnerProjectIdent": "striasdgang",
    "COSBucket": "string",
    "COSRegion": "string"
}

Output Example

{
    "Response": {
        "RequestId": "123",
        "Data": "1"
    }
}

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