Panggil API QueryWorks untuk menguji informasi data work - Quick BI - Alibaba Cloud - Quick BI

Mengkueri informasi tentang data work tertentu.

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

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WorksId	string	Yes	ID laporan.	abcd****

Elemen respons

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The ID of the request.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The details of the work.
Auth3rdFlag	integer	Third-party embedding status. Valid values: 0: The embed service is not enabled. 1: Embed is enabled.	0
Description	string	Remarks on the work.	备注
Directory	object	The directory to which the work belongs.
Id	string	The ID of the directory.	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	The name of the directory.	测试目录
PathId	string	The hierarchical structure of the directory ID to which the directory belongs. Separate the hierarchical structure with a /.	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	The hierarchical structure of the directory to which the directory belongs. Separate the hierarchical structure with a (/).	测试目录
GmtCreate	string	The timestamp of the creation of the work in milliseconds.	1496651577000
GmtModify	string	The timestamp of the modification of the work in milliseconds.	1496651577000
ModifyName	string	The Alibaba Cloud account name of the person who modified the work.	张三
OwnerId	string	The user ID of the work owner in the Quick BI.	9187a612aa474e2a8ac1414d5529****
OwnerName	string	The Alibaba Cloud account name of the work owner.	张三
PublicFlag	boolean	Is it public	true
PublicInvalidTime	integer	Deadline for the public release of the report	1721366354000
SecurityLevel	string	Security policies for collaborative authorization of works. Valid values: 0: private 12: Authorize specified members 1 or 11: Authorize all workspace members Catatan If you use legacy permissions, the return value is 1. If you use the new permissions, the return value is 11.	0
Status	integer	The status of the report. Valid values: 0: unpublished 1: published 2: modified but not published 3: unpublished	0
WorkName	string	The name of the work.	测试报表
WorkType	string	Queries the types of works. Fill in the blanks to query all types. Valid values: DATAPRODUCT: BI portal PAGE: Dashboard FULLPAGE: full-screen dashboards REPORT: workbook dashboardOfflineQuery: self-service data retrieval	PAGE
WorksId	string	The ID of the work.	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorkspaceId	string	The ID of the workspace to which the work belongs.	87c6b145-090c-43e1-9426-8f93be23****
WorkspaceName	string	The name of the workspace to which the work belongs.	测试空间

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Auth3rdFlag": 0,
    "Description": "备注",
    "Directory": {
      "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "Name": "测试目录",
      "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "PathName": "测试目录"
    },
    "GmtCreate": "1496651577000",
    "GmtModify": "1496651577000",
    "ModifyName": "张三",
    "OwnerId": "9187a612aa474e2a8ac1414d5529****",
    "OwnerName": "张三",
    "PublicFlag": true,
    "PublicInvalidTime": 1721366354000,
    "SecurityLevel": "0",
    "Status": 0,
    "WorkName": "测试报表",
    "WorkType": "PAGE",
    "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
    "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
    "WorkspaceName": "测试空间"
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Invalid.Works.Empty	This work does not exist. It may have been deleted. Work ID is %s.
400	Resource.NotBelongTo.CurrentOrganization	The resource does not belong to the current organization.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.