QueryDataServiceList API でデータサービスレコードを取得 - Quick BI

データサービス 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:QueryDataServiceList

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	任意	データサービス名。	测试sql
UserId	string	任意	ユーザー ID。	dasdfdsa-csddf-dsadsa
PageNo	integer	任意	ページ番号。デフォルト値：1。	1
PageSize	integer	任意	ページ分割クエリにおける 1 ページあたりの項目数：デフォルト値：10 最大値：1000	10

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	返される結果。
Data	array<object>	データサービス情報。
	array<object>
Content	object	JSON フォーマットのデータサービスのモデル。
CubeId	string	キューブ識別子 ID。	56f9f34a-bdba-496a-91a3-a18b1ff73a80
CubeName	string	データセット名。	测试数据集
Detail	boolean	詳細または概要	true
Filter	object	リクエストパラメーター情報。
Filters	array<object>	複合条件。
	object	詳細な階層型ポータルメニューリストの JSON 文字列。有効値は次のとおりです： Type：タイプ。 1.basic：基本 2.combined：複合 field：対応するキューブフィールド alias：パラメーター名 desc：フィールドの説明 aggregator：集約関数 operator：オペレーター essential：必須かどうか defaultValue：システムのデフォルト値。API 呼び出しで指定されない場合、この値が代替として使用されます。 interval：日付オフセット。これは日付に対して有効で、デフォルト値またはパラメーター値に対する相対値を表します。 logicalOperator：論理演算子 filters：複合条件 (これはネスト構造です)	[{ "field": { "fid": "1c1f88cb7d", "granularity": "yearRegion", "dataType": "datetime", "column": "s_date", "caption": "日期(year)", "type": "dimension" }, "defaultValue": ["2024"], "alias": "s_date", "type": "basic", "operator": "equal-to", "essential": true }]
LogicalOperator	string	複数の SQL テキストキーワード間の論理関係。 or：or and：and	and
Type	string	タイプ。 basic：基本 combined：複合	basic
ReturnFields	array<object>	返される情報。
	array<object>
Aggregator	string	集約オペレーター。例：SUM、AVG、MAX。	SUM
Alias	string	フィールドパラメーター名。	s_number
Desc	string	返されるフィールドの備考。	主题配置已存在。
Field	object	対応するキューブフィールド情報。
Caption	string	キューブモデルでの表示名 (中国語または英語が可能です)。	日期(year)
Column	string	対応する物理フィールド名。	shid_star
DataType	string	データ型。 number：数値 string：文字列 date：日付 datetime：日時 time：時刻 geographic：地理 boolean：ブール値 url：URL	datetime
Fid	string	元のフィールドの一意の識別子。	1c1f88cb7d
Granularity	string	この属性は日付および地理ディメンションに含まれ、サポートされている粒度を示します。	yearRegion
Name	string	キューブフィールドの一意の名前で、主に返される結果での一意の特定に使用されます。	sss
Type	string	タイプ。 Dimension：ディメンション Measure：メジャー	dimension
Orderby	string	ソート。 asc：昇順 desc：降順 no：ソートなし	no
CreatorId	string	作成者 ID。	7cb94cd48701
CreatorName	string	作成者名。	张仔龙
CubeId	string	キューブ識別子 ID。	d14e7448-0eb3-40d3-9375-4afef8de29fd
CubeName	string	データセット名。	测试数据集
Desc	string	説明	测试用
GmtCreate	string	作成時刻。	2023-05-18 14:00:02.0
GmtModified	string	更新時刻。	2023-03-21 18:02:36
ModifierId	string	更新者のユーザー ID。	7cb94cd48701
ModifierName	string	更新者名	张仔龙
Name	string	データサービス名。	测试报表
OwnerId	string	所有者 ID	862801339
OwnerName	string	所有者名	李四
Sid	string	データサービスの一意の ID。	dtsuq3i31f5j8v848b
WorkspaceId	string	ワークスペース ID。	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	ワークスペース名。	测试工作空间
PageNum	integer	ページ番号。	1
PageSize	integer	1 ページあたりのレコード数。	10
TotalNum	integer	総行数。	1
TotalPages	integer	総ページ数。	1
Success	boolean	リクエストが成功したかどうかを示します。有効値： true：リクエストは成功しました false：リクエストは失敗しました	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "78C1AA2D-9201-599E-A0BA-6FC462E57A95",
  "Result": {
    "Data": [
      {
        "Content": {
          "CubeId": "56f9f34a-bdba-496a-91a3-a18b1ff73a80",
          "CubeName": "测试数据集",
          "Detail": true,
          "Filter": {
            "Filters": [
              [
                {
                  "field": {
                    "fid": "1c1f88cb7d",
                    "granularity": "yearRegion",
                    "dataType": "datetime",
                    "column": "s_date",
                    "caption": "日期(year)",
                    "type": "dimension"
                  },
                  "defaultValue": [
                    "2024"
                  ],
                  "alias": "s_date",
                  "type": "basic",
                  "operator": "equal-to",
                  "essential": true
                }
              ]
            ],
            "LogicalOperator": "and",
            "Type": "basic"
          },
          "ReturnFields": [
            {
              "Aggregator": "SUM",
              "Alias": "s_number",
              "Desc": "主题配置已存在。",
              "Field": {
                "Caption": "日期(year)",
                "Column": "shid_star",
                "DataType": "datetime",
                "Fid": "1c1f88cb7d",
                "Granularity": "yearRegion",
                "Name": "sss",
                "Type": "dimension"
              },
              "Orderby": "no"
            }
          ]
        },
        "CreatorId": "7cb94cd48701",
        "CreatorName": "张仔龙",
        "CubeId": "d14e7448-0eb3-40d3-9375-4afef8de29fd",
        "CubeName": "测试数据集",
        "Desc": "测试用",
        "GmtCreate": "2023-05-18 14:00:02.0",
        "GmtModified": "2023-03-21 18:02:36",
        "ModifierId": "7cb94cd48701",
        "ModifierName": "张仔龙\n",
        "Name": "测试报表",
        "OwnerId": "862801339",
        "OwnerName": "李四",
        "Sid": "dtsuq3i31f5j8v848b",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	Invalid.User.Organization	The user is not in your organization.

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

変更履歴

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