Kueri sumber data API dengan memanggil ListApiDatasource - Quick BI - Alibaba Cloud - Quick BI

Mengkueri sumber data API.

Deskripsi operasi

For more information about the parameters, see Create an API data source.

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:ListApiDatasource

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID ruang kerja.	89713491-cb4f-4579-b889-e82c35f1****
PageNum	integer	No	Nomor halaman saat ini dari daftar sumber data API. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah baris per halaman dalam kueri berhalaman. Nilai default: 10. Nilai valid: 1 hingga 100.	10
KeyWord	string	No	Kata kunci nama sumber data API.	测试

Elemen respons

Element	Type	Description	Example
	object	The information returned.
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The query results are returned.
Data	array<object>	The list of API data sources that were queried.
	object
ApiId	string	The ID of the API data source.	0f2c3c6409be4dc0810f2a5785e816a8
Body	string	The parameter configuration of the query statement in JSON format. You can customize the parameter configuration.	{"key1":"value1"}
DataSize	number	The data volume of the API data source. Unit: Kbit/s	0.39746094
DateUpdateTime	string	The last synchronization time of the API data source.	2022-05-25 16:19:43
GmtCreate	string	The time when the quota plan was created.	2022-05-25 16:19:43
GmtModified	string	The time when the optimization job was modified.	2022-05-25 16:19:43
JobId	string	The job ID.	REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8
Parameters	string	The parameter configurations in the JSONArray format. name: parameter name value: the parameter value	[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]
ShowName	string	The name of the API data source.	测试数据源
StatusType	integer	The status of the API data source synchronization task. Valid values: 0: the to be run. 1: The is running. 2: The is successfully. 3: failed. Valid values: 0 : 1 : 2 : 3 :	2
PageNum	integer	The page number.	1
PageSize	integer	The number of rows per page set when the interface is requested.	10
TotalNum	integer	The total number of rows.	1
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "ApiId": "0f2c3c6409be4dc0810f2a5785e816a8",
        "Body": "{\"key1\":\"value1\"}",
        "DataSize": 0.39746094,
        "DateUpdateTime": "2022-05-25 16:19:43",
        "GmtCreate": "2022-05-25 16:19:43",
        "GmtModified": "2022-05-25 16:19:43",
        "JobId": "REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8",
        "Parameters": "[{\"name\":\"token\",\"value\":\"xxxxxxxxxxxx\"},{\"name\":\"pageSize\",\"value\":100}]",
        "ShowName": "测试数据源",
        "StatusType": 2
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1
  },
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.