DataService Studio API で安全なデータアクセスを行う - Quick BI - Alibaba Cloud -

DataService Studio で作成した API を呼び出します。

操作説明

前提条件

Quick BI の DataService Studio で API が作成されている必要があります。詳細については、「DataService Studio」をご参照ください。

制限

DataService Studio は Professional Edition でのみ使用できます。
DataService Studio の API 呼び出しのタイムアウト期間は 60 秒です。単一 API の 1 秒あたりのクエリ数 (QPS) は 10 です。
DataService Studio の API で参照されるデータセットに行レベルの権限を有効にすると、行レベルのアクセスポリシーが API 呼び出しをインターセプトします。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ApiId	string	必須	DataService Studio の API の ID です。詳細については、「DataService Studio」をご参照ください。	f4cc43bc3***
UserId	string	任意	Quick BI のユーザー ID です。ユーザー ID の取得方法の詳細については、「QueryUserInfoByAccount」をご参照ください。説明このパラメーターは、DataService Studio を使用するユーザーのアイデンティティを指定します。データセットの行レベルおよび列レベルの権限設定と組み合わせて使用できます。重要このパラメーターを渡さない場合や、空の文字列または null を渡した場合は、デフォルトで現在の Quick BI 組織の所有者のユーザー ID が使用されます。	b5d8fd9348cc4327****afb604
Conditions	string	任意	DataService Studio のフィルター条件です。条件は、マップ形式の文字列でキーと値のペアとして渡します。キーはリクエストパラメーターの名前で、値はリクエストパラメーターの値です。キーと値はペアで指定する必要があります。注：リクエストパラメーターの演算子が列挙フィルターに設定されている場合、値には複数の値を含めることができます。この場合、値は JSON 配列形式である必要があります。例： `area=["East China","North China","South China"]` 日付については、日付の種類に基づいて次の形式を使用します。年： 2019 四半期： 2019Q1 月： 201901 (先行ゼロあり) 週： 2019-52 日： 20190101 時： 14:00:00 (分と秒は 00) 分： 14:12:00 (秒は 00) 秒： 14:34:34	{ "area": ["test", "test"], "shopping_date": "2019Q1", }
ReturnFields	string	任意	返されるパラメーター名のリスト（リスト形式の文字列）です。	["area", "city", "price", "date"]

レスポンスフィールド

フィールド	型	説明	例
	object
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
RequestId	string	リクエスト ID です。	a4d1a221d-41za1-****
Result	object	API 呼び出しの結果です。 true: The call was successful. false: The call failed.
Headers	array<object>	列ヘッダーです。
	object	列ヘッダーです。
Aggregator	string	集計演算子です。このパラメーターは、SUM 、AVG 、MAX などのメジャーフィールドに対してのみ返されます。 SUM：合計。 MAX：最大値。 MIN：最小値。 AVG：平均値。 COUNT：件数。 COUNTD：一意の値の件数。 STDDEV_POP：母標準偏差。 STDDEV_SAMP：標本標準偏差。 VAR_POP：母分散。 VAR_SAMP：標本分散。	SUM
Column	string	フィールド名です。物理テーブル内のフィールド名に対応します。	test
DataType	string	フィールドのデータ型です。一般的な型は次のとおりです： number string date time datetime	string
Granularity	string	ディメンションフィールドの粒度です。このパラメーターは、要求されたフィールドが日付ディメンションまたは地理ディメンションの場合にのみ返されます。有効な値：日付の粒度：yearRegion (年) 、monthRegion (月) 、weekRegion (週) 、dayRegion (日) 、hourRegion (時) 、minRegion (分) 、secRegion (秒) 地理の粒度：COUNTRY (国) 、PROVINCE (省) 、CITY (市) 、XIAN (郡/区) 、REGION (地域)	REGION
Label	string	フィールドのエイリアスです。結果パラメーター values におけるマップデータ行のキーです。	area
Type	string	フィールドタイプです。フィールドがディメンションかメジャーかを示します。ディメンションメジャー	Dimension
OriginalColumn	string	データセット内の対応するフィールドの元の名前です。	area
Sql	string	クエリの SQL 文です。説明返される SQL 文には、この API 呼び出しで渡したフィルター条件に加えて、行レベルの権限および列レベルの権限設定も含まれます。	SELECT COMPANY_T_1_.`area` AS D_AREA_2_, COMPANY_T_1_.`city` AS D_CITY_3_, SUM(COMPANY_T_1_.`profit_amt`) AS D_PROFIT_4_ FROM `quickbi_test`.`company_sales_record_copy` AS COMPANY_T_1_ WHERE COMPANY_T_1_.`area` LIKE '%test%' GROUP BY COMPANY_T_1_.`area`, COMPANY_T_1_.`city` HAVING SUM(COMPANY_T_1_.`order_amt`) > 1 LIMIT 0, 10
Values	array<object>	クエリ結果です。
	object	返されるデータの行と列です。このパラメーターは List<Map> 構造です。マップ内のキーは `Headers#Label` フィールドに対応します。	[{"area":"test","city":"test"},{"area":"test","city":"test"}]

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "a4d1a221d-41za1-****",
  "Result": {
    "Headers": [
      {
        "Aggregator": "SUM",
        "Column": "test",
        "DataType": "string",
        "Granularity": "REGION",
        "Label": "area",
        "Type": "Dimension",
        "OriginalColumn": "area"
      }
    ],
    "Sql": "SELECT COMPANY_T_1_.`area` AS D_AREA_2_, COMPANY_T_1_.`city` AS D_CITY_3_, SUM(COMPANY_T_1_.`profit_amt`) AS D_PROFIT_4_ FROM `quickbi_test`.`company_sales_record_copy` AS COMPANY_T_1_ WHERE COMPANY_T_1_.`area` LIKE '%test%' GROUP BY COMPANY_T_1_.`area`, COMPANY_T_1_.`city` HAVING SUM(COMPANY_T_1_.`order_amt`) > 1 LIMIT 0, 10",
    "Values": [
      [
        {
          "area": "test",
          "city": "test"
        },
        {
          "area": "test",
          "city": "test"
        }
      ]
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	API.No.Permission	You are not authorized to call the data service API operation.
400	API.Not.Exist	The data service API operation does not exist.
400	Cube.Not.Exist	The Cube does not exist.
400	Invalid.Parameter.Conditions	The specified Conditions is invalid. %s is not defined.
400	Invalid.Parameter.ReturnFields	The specified returnFields is invalid. %s is not defined.
400	Missing.Conditions	The specified Conditions is invalid. You must specify %s.
400	Missing.Dimension.Measure	The dimension or measure %s does not exist in Cube.
400	Rowlevel.Permission.Forbbiden	The request is denied by row level permission. The dataset is %s, %s %s.
400	Datasource.Sql.ExecuteFailed	Failed to execute the SQL statement in the data source.
400	DataService.InputParam.Error	input parameter error: %s.

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

変更履歴

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