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

:CreateCubeBySql

最終更新日:Jul 02, 2026

カスタム SQL ステートメントに基づいてデータセットを作成します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:CreateCubeBySql

create

*All Resource

*

なし なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

CustomSql

string

必須

カスタム SQL ステートメント。

select * from qqq

Caption

string

必須

カスタムデータセットの名前。

test

DsId

string

必須

データソース ID。

7AAB95D-*****-****-*4FC0C976

WorkspaceId

string

必須

ワークスペース ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****

UserId

string

必須

データセットを作成する権限を持つユーザーの Quick BI UserId。これは Alibaba Cloud アカウント ID ではありません。 QueryUserInfoByAccount 操作を呼び出して UserId を取得できます。

asdaf-asda*****asd

Placeholders

string

任意

プレースホルダーパラメーター。詳細については、以下の補足説明を参照してください。フォーマットについては下記を参照してください。

[ { "name": "test", "style": "placeholder", "type": "string" } ]

プレースホルダー PlaceholderModel 構造

  • uniqueId -- string、任意。プレースホルダーの一意の ID。作成時にこのパラメーターを指定する必要はありません。指定しても使用されません。(このフィールドは更新時に使用されます。)

  • name -- string、必須。プレースホルダー名。一意である必要があります。

  • style -- string、必須。プレースホルダーのタイプ。

    • 式プレースホルダー: param

    • 値プレースホルダー: placeholder

    • 条件プレースホルダー: condition

  • type -- String。プレースホルダーの変数タイプ。

    • テキスト: string

    • 数値: number

    • 日付: 以下のフォーマット説明を参照

  • useInGlobal -- Boolean、任意。プレースホルダーがグローバルに有効かどうかを指定します。デフォルト値: false。

    • はい: true

    • いいえ: false

  • defaultValue -- List、任意。プレースホルダーのデフォルト値。shipping_date_ph.get(0) プレースホルダータイプの場合、デフォルト値の数は 0 または 2 のみです。その他のプレースホルダータイプの場合、数は 0 または 1 のみです。

  • format -- String、任意。日付タイプのフォーマット。(以下のフォーマット説明を参照。)

  • originalType -- String、任意。値プレースホルダーが shipping_date_ph.get(0) の日付タイプの場合、originalType を dateRange に設定します。その他の場合、このパラメーターを設定する必要はありません。

  • conditionPlaceHolderFields -- List、任意。条件プレースホルダーフィールド。このパラメーターは条件プレースホルダーの場合にのみ必要です。

ConditionPlaceHolderFields 構造

  • uniqueId -- String、任意。条件プレースホルダーフィールドの一意の ID。作成時にこのパラメーターを指定する必要はありません。システムがデフォルトで値を生成します。

  • column -- String、必須。物理フィールド名。

式プレースホルダーの style と type のマッピング

変数タイプ ### 対応する type 値。

  • テキスト string

  • 数値 number

  • 日付-年 yearRegion

  • 日付-年四半期 quarterRegion

  • 日付-年月 monthRegion

  • 日付-年週 weekRegion

  • 日付-年月日 dateRegion

  • 日付-年月日時分秒 ymdHmsRegion

値プレースホルダーの style、type、フォーマットのマッピング(空欄は不要を意味します)

変数タイプ ### 対応する type 値 ### フォーマット。

  • テキスト string(shipping_date_ph.get(0) 日付タイプではサポートされていません)

  • 数値 number(shipping_date_ph.get(0) 日付タイプではサポートされていません)

  • 日付-年 yearRegion

  • 日付-年四半期 quarterRegion

  • 日付-年月 monthRegion 次の 3 つのフォーマットから選択: YYYY-MM、YYYYMM、または YYYY/MM

  • 日付-年週 weekRegion

  • 日付-年月日 dateRegion 次の 3 つのフォーマットから選択: YYYY-MM-DD、YYYYMMDD、または YYYY/MM/DD

  • 日付-年月日時分秒 ymdHmsRegion 次の 4 つのフォーマットから選択: YYYY-MM-DD HH:MI:SS、YYYYMMDD HH:MI:SS、YYYY/MM/DD HH:MI:SS、または YYYYMMDDHHMISS

条件プレースホルダーの style と type のマッピング

変数タイプ ### 対応する type 値。

  • テキスト string。

レスポンスフィールド

フィールド

説明

object

応答のスキーマ。

RequestId

string

リクエスト ID。

05739b************02522b9

Result

string

操作の実行結果。有効な値:

  • true: リクエストが成功しました。

  • false: リクエストが失敗した。

true

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true: リクエストが成功しました。

  • false: リクエストが失敗した。

true

成功レスポンス

JSONJSON

{
  "RequestId": "05739b************02522b9",
  "Result": "true",
  "Success": true
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Internal.System.Error An internal system error occurred.
400 Invalid.User.Organization The user is not in your organization.
400 User.NotIn.Workspace The user is not in this workspace.
400 Invalid.Workspace The workspace is not owned by the organization.
400 Datasource.NotFound.Error The specified data source does not exist: %s. 指定されたデータソースは存在しません:%s。
400 DatasourceId.IsNull.Error You must select a data source before selecting the table. テーブルを選択する前に、データソースを選択する必要があります。
400 Name.RegularExpression.Error Name format validation failed.
400 NameExceeded.MaxLength.Error The name cannot exceed %s characters in length.
400 Cube.DuplicatedName.Error The dataset name already exists. Modify the name before saving.
400 Directory.NotExist.Error The directory does not exist.
400 Xengnie.TaskExecute.Error Fail to execute task %s.
400 Datasource.Sql.ExecuteFailed Failed to execute the SQL statement in the data source.
400 Placeholder.Date.Illegal The placeholder date format is illegal.
400 Placeholder.DefaultValue.Invalid Invalid placeholder default value.
400 Placeholder.FieldNot.Empty Condition placeHolder field not empty.
400 Placeholder.Style.Illegal Illegal placeholder style.
400 Placeholder.Type.Illegal Illegal placeholder type.
400 Placeholder.UniqueId.Duplicate Sql placeholder uniqueId duplicate.
400 PlaceholderName.Duplicate.Error Sql placeholder name duplicate.
400 PlaceholderName.NotMatch.Error The parsing and input placeholder names do not match.

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

変更履歴

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