Ambil Rekaman Layanan Data melalui API QueryDataServiceList-Quick BI-Alibaba Cloud - Quick BI

Daftar API Layanan Data Kueri

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryDataServiceList

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Name	string	No	Nama layanan data.	测试sql
UserId	string	No	ID Pengguna.	dasdfdsa-csddf-dsadsa
PageNo	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah item per halaman dalam kueri berhalaman: Nilai default: 10 Nilai maksimum: 1000	10

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID Permintaan.	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	Mengembalikan hasil.
Data	array<object>	Informasi layanan data.
	array<object>
Content	object	The model of the data service in JSON format.
CubeId	string	Cube identifier ID.	56f9f34a-bdba-496a-91a3-a18b1ff73a80
CubeName	string	Dataset name.	测试数据集
Detail	boolean	Detail or Summary	true
Filter	object	Request parameter information.
Filters	array<object>	Combined conditions.
	object	JSON string of detailed hierarchical portal menu list. The value range includes: Type: type. 1.basic: basic 2.combined: complex field: corresponding cube field alias: parameter name desc: field description aggregator: aggregation function operator: operator essential: whether it is required defaultValue: system default value. If not provided in the API call, this value will be used as a replacement. interval: date offset. This is valid for dates, representing the relative value to the default value or the parameter value. logicalOperator: logical operator filters: combined conditions (this is a nested structure)	[{ "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	Logical relationship between multiple SQL text keywords. or: or and: and	and
Type	string	Type. basic: basic combined: complex	basic
ReturnFields	array<object>	Return information.
	array<object>
Aggregator	string	Aggregation operator. For example, SUM, AVG, and MAX.	SUM
Alias	string	Field parameter name.	s_number
Desc	string	Remark for the returned field.	主题配置已存在。
Field	object	Corresponding cube field information.
Caption	string	Display name in the cube model (can be in Chinese or English).	日期(year)
Column	string	The corresponding physical field name.	shid_star
DataType	string	Data type. number: numeric string: string date: date datetime: datetime time: time geographic: geographic boolean: boolean url: URL	datetime
Fid	string	Unique identifier for the original field.	1c1f88cb7d
Granularity	string	This attribute is included for date and geographic dimensions, indicating the supported granularity.	yearRegion
Name	string	Unique name of the cube field, mainly used for unique positioning in the returned result.	sss
Type	string	Type. Dimension: Dimension Measure: Measure	dimension
Orderby	string	Sorting. asc: Ascending desc: Descending no: No sorting	no
CreatorId	string	Creator ID.	7cb94cd48701
CreatorName	string	Creator's name.	张仔龙
CubeId	string	Cube identifier ID.	d14e7448-0eb3-40d3-9375-4afef8de29fd
CubeName	string	Dataset name.	测试数据集
Desc	string	Description	测试用
GmtCreate	string	Creation time.	2023-05-18 14:00:02.0
GmtModified	string	Modification time.	2023-03-21 18:02:36
ModifierId	string	Modifier's userId.	7cb94cd48701
ModifierName	string	Modifier's name	张仔龙
Name	string	Data service name.	测试报表
OwnerId	string	Owner ID	862801339
OwnerName	string	Owner's name	李四
Sid	string	Unique ID of the data service.	dtsuq3i31f5j8v848b
WorkspaceId	string	Workspace ID.	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	Workspace name.	测试工作空间
PageNum	integer	Nomor halaman.	1
PageSize	integer	Jumlah catatan per halaman.	10
TotalNum	integer	Jumlah total baris.	1
TotalPages	integer	Jumlah total halaman.	1
Success	boolean	Menunjukkan apakah permintaan berhasil. Rentang nilai: true: Permintaan berhasil false: Permintaan gagal	true

Contoh

Respons sukses

JSONformat

{
  "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
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	Invalid.User.Organization	The user is not in your organization.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.