API でプログラムによりデータソースを DataWorks に追加 - DataWorks - Alibaba Cloud - DataWorks

操作説明

DataWorks Basic Edition 以上のエディションを購入している必要があります。
DataWorks プロジェクトワークスペースで、以下のロールのいずれか 1 つ以上を保有している必要があります:

テナントオーナー、ストレージ管理管理者、プロジェクトオーナー、または O&M

今すぐお試しください

この 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

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID です。DataWorks コンソールにログインし、[ワークスペース管理] ページに移動して ID を取得できます。このパラメーターは、この API 呼び出しの対象となる DataWorks ワークスペースを指定します。	2
Name	string	必須	データソースの名前です。名前には英字、数字、アンダースコア (_) を使用でき、数字またはアンダースコアで始めることはできません。名前の長さは最大 255 文字です。	demo_holo_datasource
Type	string	必須	データソースのタイプです。70 種類以上のデータソースタイプがサポートされています。列挙されたデータソースタイプの詳細については、リファレンス「データソースタイプリスト」をご参照ください。	hologres
ConnectionPropertiesMode	string	必須	データソースの接続モードです。タイプごとにサブタイプが異なり、パラメーターの制約も異なります。たとえば、MySQL データソースでは以下のモードがサポートされています: InstanceMode (インスタンスモード) UrlMode (接続文字列モード)	UrlMode
Description	string	任意	データソースの説明です。説明の長さは最大 3,000 文字です。	this is a holo datasource
ConnectionProperties	string	必須	エンドポイント、アクセス ID、環境コンテキストを含むデータソースの接続プロパティです。envType プロパティはこのオブジェクトのメンバーであり、データソース環境を指定します。有効な値: Dev: 開発環境。 Prod: 本番環境。異なる接続パターン (ConnectionPropertiesMode) では、データソースタイプごとに異なるプロパティ仕様があります。詳細については、「データソース接続プロパティ 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-EB3C6****
Id	integer	作成されたデータソースの ID です。これはデータソースの一意の識別子です。	22130

例

成功レスポンス

JSONJSON

{
  "RequestId": "B62EC203-B39E-5DC1-B5B8-EB3C6****",
  "Id": 22130
}

エラーコード

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

変更履歴

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