すべてのプロダクト
Search
ドキュメントセンター

DataWorks:CreateDataSource

最終更新日:Mar 21, 2026

ワークスペースの開発環境または本番環境にデータソースを追加します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:CreateDataSource

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ProjectId

integer

必須

DataWorks ワークスペースの ID です。DataWorks コンソール にログインし、ワークスペース管理ページで ID を確認できます。

このパラメーターは、この API 呼び出しで使用する DataWorks ワークスペースを特定するために使用されます。

2

Name

string

必須

データソースの名前です。名前は最大 255 文字まで指定でき、英字、数字、アンダースコア (_) を使用できます。先頭文字は英字である必要があります。

demo_holo_datasource

Type

string

必須

データソースのタイプです。DataWorks では 70 種類以上のデータソースがサポートされています。詳細については、「データソースの種類」をご参照ください。

hologres

ConnectionPropertiesMode

string

必須

データソースを追加するモードです。モードはデータソースのタイプによって異なります。MySQL データソースの場合の有効値は以下のとおりです。

  • InstanceMode:インスタンスモード

  • UrlMode:接続文字列モード

UrlMode

Description

string

任意

データソースの説明です。説明は 3,000 文字以内である必要があります。

this is a holo datasource

ConnectionProperties

string

必須

データソースの接続構成です。接続構成には、エンドポイント、アクセス ID、環境情報などが含まれます。envType パラメーターは、データソースを使用する環境を指定します。envType パラメーターの有効値は以下のとおりです。

  • Dev:開発環境

  • Prod:本番環境

データソースの追加モードによって、設定が必要なパラメーターは異なります。詳細については、「データソースの接続情報 (ConnectionProperties)」をご参照ください。

{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }

レスポンスフィールド

フィールド

説明

object

返された結果です。

RequestId

string

リクエスト ID です。この ID を使用してログを検索し、問題をトラブルシューティングできます。

B62EC203-B39E-5DC1-B5B8-EB3C61707009

Id

integer

データソース ID です。

22130

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。