Tüm Ürünler
Search

Bu Ürün

    :GetWorksEmbedList

    Belge Merkezi

    :GetWorksEmbedList

    Son Güncelleme:Oct 01, 2026

    Gömülü raporların listesini sorgular.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    quickbi-public:GetWorksEmbedList

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    WsId

    string

    No

    Çalışma alanı kimliği.

    919818-***-*****-wdasd
    WorksType

    string

    No

    Rapor türü. Geçerli değerler:

    • page: gösterge paneli.

    • screen: veri ekranı.

    • report: çalışma kitabı.

    • ANALYSIS: özel analiz.

    • dashboardOfflineQuery: self-servis veri alma.

    • dataForm: veri giriş formu.

    Valid values:

    • dataForm :

      Veri giriş formu.

    • dashboardOfflineQuery :

      Self-servis veri alma.

    • report :

      Çalışma kitabı.

    • screen :

      Veri ekranı.

    • ANALYSIS :

      Özel analiz.

    • page :

      Gösterge paneli.

    page
    Keyword

    string

    No

    Bulanık eşleştirme için rapor adı.

    Test dataset
    PageNo

    integer

    No

    Sayfa numarası. Varsayılan değer: 1.

    1
    PageSize

    integer

    No

    Sayfa başına giriş sayısı. Varsayılan değer: 10.

    100

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    İstek kimliği.

    38C0F*****0-415****9F1-*****422BDB65
    Result

    object

    Rapor dizisi nesnesi.

    Data

    array<object>

    Rapor dizisi.

    object

    Rapor nesnesi.

    EmbedTime

    string

    Raporun gömüldüğü zaman, YYYY-mm-DD hh:MM:ss formatında.

    YYYY-mm-DD hh:MM:ss
    WorksId

    string

    Rapor kimliği.

    897ce25e-****-****-af84-d13c5610****
    WorksName

    string

    Rapor adı.

    Test
    WorksType

    string

    Rapor türü.

    page
    WorkspaceId

    string

    Raporun ait olduğu çalışma alanının kimliği.

    87c6b145-****-43e1-9426-8f93be23****
    PageNo

    integer

    Sayfa numarası.

    1
    PageSize

    integer

    Sayfa başına giriş sayısı.

    10
    TotalNum

    integer

    Toplam giriş sayısı.

    18
    TotalPages

    integer

    Toplam sayfa sayısı.

    2
    Success

    boolean

    İsteğin başarılı olup olmadığını gösterir.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "38C0F*****0-415****9F1-*****422BDB65",
  "Result": {
    "Data": [
      {
        "EmbedTime": "YYYY-mm-DD hh:MM:ss",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorksName": "test",
        "WorksType": "page",
        "WorkspaceId": "87c6b145-****-43e1-9426-8f93be23****"
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "TotalNum": 18,
    "TotalPages": 2
  },
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.